[Dojo-checkins] [dojo] #10299: errors during Sphinx "make html" process

[dojo]

#10299: errors during Sphinx "make html" process
---------------------------+------------------------------------------------
 Reporter:  MarcusReimann  |        Type:  defect       
   Status:  new            |    Priority:  normal       
Milestone:  1.4            |   Component:  Documentation
  Version:  1.4.0b         |    Severity:  normal       
 Keywords:                 |  
---------------------------+------------------------------------------------
 There are some errors during the "make html" process with Sphinx. This
 errors lead to missing links (and pages) within the Dojo docs which are
 delivered with each new release.

 Example: Within the page dojo/index.html there should be a link to the
 djConfig-page, but the current make process isn't able to find this link
 and as a consequent doesn't link to this page. The result is, that the
 whole page for djConfig (with important informations about djConfig) is
 missed in the exported HTML files.

 The problem seems to be the handling of the relative/absoulute links
 within the make process:

 If you look at the Wiki page http://docs.dojocampus.org/dojo/index, you'll
 find the following link:

 {{{
 `djConfig <djConfig>`_
 }}}

 This link works great within the MoinMoin wiki. After the export from
 MoinMoin there is the same link in another form available within the file
 source/dojo/index.rst:

 {{{
 :doc:`djConfig </djConfig>`
 }}}

 During the make process Sphinx warns, that it's not possible to find the
 file "djConfig". And with that, Sphinx doesn't link to the page "djConfig"
 and also don't create the "djConfig.html" file.

 It seems, Sphinx is only able to search within the current working
 directory, but not in the directory above (djConfig is located in source/
 and not in source/dojo/).

 During my investigation I've also found another problem: There are old
 and/or wrong files in the directory source/:

 * dijit-a11y-req.rst (have to be moved to dijit/a11/req.rst, the link
 within http://docs.dojocampus.org/dijit/index have to be changed)

 * dijit-a11y-resources.rst (have to be moved to dijit/a11/resources.rst,
 the link within http://docs.dojocampus.org/dijit/index have to be changed)

 * dijit-a11y.rst (have to be moved to  dijit/a11/index.rst, the link
 within http://docs.dojocampus.org/dijit/index have to be changed)

 * dijit-a11y-statement.rst (have to be moved to dijit/a11/statement.rst,
 the link within http://docs.dojocampus.org/dijit/index have to be changed)

 * dijit-a11y-strategy.rst (have to be moved to dijit/a11/strategy.rst, the
 link within http://docs.dojocampus.org/dijit/index have to be changed)

 * dijit.rst  (The content does not reflect the current state of the Wiki.
 There is just an "#REDIRECT dijit/index" within this page)

 * dijit-themes.rst (have to be moved to dijit/themes.rst)

 * dojoc.rst (The file is already deleted within the Wiki. However, the
 file still exists within the source/-directory)

 * dojo.rst (The content does not reflect the current state of the Wiki.
 There is just an "#REDIRECT dojo/index" within this page)

 * internals.rst (seems to be outdated)

 * manual.rst (The file is already deleted within the Wiki. However, the
 file still exists within the source/-directory)

 Regards,
  Marcus

-- 
Ticket URL: <http://bugs.dojotoolkit.org/ticket/10299>
dojo <http://dojotoolkit.org/>
The Dojo UI Toolkit