Copy Page

You are not logged in. Any changes you make will be marked as anonymous. You may want to Log In if you already have an account. You can also Sign Up for a new account.

<table class="confluenceTable"><tbody><tr><th class="confluenceTh"><p>Motivation:</p></th><td class="confluenceTd"><p><em>Finalize sphinx documentation practice</em></p></td></tr><tr><th class="confluenceTh"><p>Contact:</p></th><td class="confluenceTd"><p><a class="confluence-link confluence-userlink" data-username="jdeolive" href="/display/~jdeolive" data-linked-resource-id="14894" data-linked-resource-type="userinfo" username="jdeolive" data-linked-resource-default-alias="Justin Deoliveira" data-base-url="http://docs.codehaus.org">Justin Deoliveira</a></p></td></tr><tr><th class="confluenceTh"><p>Tracker:</p></th><td class="confluenceTd"><p><a href="http://jira.codehaus.org/browse/GEOT-3114">http://jira.codehaus.org/browse/GEOT-3114</a></p></td></tr><tr><th class="confluenceTh"><p>Tagline:</p></th><td class="confluenceTd"><p><table class="wysiwyg-macro" data-macro-name="excerpt" data-macro-parameters="atlassian-macro-output-type=INLINE" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2V4Y2VycHQ6YXRsYXNzaWFuLW1hY3JvLW91dHB1dC10eXBlPUlOTElORX0&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="RICH_TEXT"><tr><td class="wysiwyg-macro-body"><p>Sphinx documentation process</p></td></tr></table></p></td></tr></tbody></table><p>This page represents the <strong>current</strong> plan; for discussion please check the tracker link above.</p><table class="wysiwyg-macro" data-macro-name="section" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e3NlY3Rpb259&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="RICH_TEXT"><tr><td class="wysiwyg-macro-body"><table class="wysiwyg-macro" data-macro-name="column" data-macro-parameters="width=70%" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvbHVtbjp3aWR0aD03MCV9&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="RICH_TEXT"><tr><td class="wysiwyg-macro-body"><img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e3RvY30&amp;locale=en_GB&amp;version=2" data-macro-name="toc"></td></tr></table><table class="wysiwyg-macro" data-macro-name="column" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvbHVtbn0&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="RICH_TEXT"><tr><td class="wysiwyg-macro-body"><p>Children:</p><img class="editor-inline-macro" src="/plugins/servlet/confluence/placeholder/macro?definition=e2NoaWxkcmVufQ&amp;locale=en_GB&amp;version=2" data-macro-name="children"></td></tr></table></td></tr></table><h1>Description</h1><p>This proposal outlines a process for generating and managing project documentation with Sphinx.</p><h2>Doc Organization</h2><p>Documentation will be organized into three categories:</p><p>#. user guide<br /> #. developer guide<br /> #. web site</p><p>And reorganized in svn as follows:</p><table class="wysiwyg-macro" data-macro-name="code" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvZGV9&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>trunk/
  docs/
    devel/
    user/
    web/
  modules/
  ...
</pre></td></tr></table><h2>Doc Generation</h2><p>The maven build will be updated to build documentation. This will involve having maven invoke the sphinx-build utility (through ant). With this building documentation will be no different than building a regular module.</p><h2>Doc Assembly</h2><p>The assembly process that produces the bin and src artifacts will be updated. A third assembly will be added for the user guide. And potentially a fourth for the developer guide.</p><h2>Doc Continuous Build</h2><p>The hudson server will be updated to build docs continuously in the same manner the rest of the code base is built when changes occur. On successful builds the latest version of the documentation will be published.</p><h1>Status</h1><p>Completed.</p><p>Voting:</p><ul><li><a class="confluence-link confluence-userlink" data-username="aaime" href="/display/~aaime" data-linked-resource-id="787" data-linked-resource-type="userinfo" username="aaime" data-linked-resource-default-alias="Andrea Aime" data-base-url="http://docs.codehaus.org">Andrea Aime</a> +1</li><li><a class="confluence-link confluence-userlink" data-username="bencaradocdavies" href="/display/~bencaradocdavies" data-linked-resource-id="60850191" data-linked-resource-type="userinfo" username="bencaradocdavies" data-linked-resource-default-alias="Ben Caradoc-Davies" data-base-url="http://docs.codehaus.org">Ben Caradoc-Davies</a> +1</li><li><a class="confluence-link confluence-userlink" data-username="christian.mueller@nvoe.at" href="/display/~christian.mueller@nvoe.at" data-linked-resource-id="75366406" data-linked-resource-type="userinfo" username="christian.mueller@nvoe.at" data-linked-resource-default-alias="Christian Mueller" data-base-url="http://docs.codehaus.org">Christian Mueller</a> +1</li><li><a class="confluence-link confluence-userlink" data-username="ianturton" href="/display/~ianturton" data-linked-resource-id="800" data-linked-resource-type="userinfo" username="ianturton" data-linked-resource-default-alias="Ian Turton" data-base-url="http://docs.codehaus.org">Ian Turton</a> +1</li><li><a class="confluence-link confluence-userlink" data-username="jdeolive" href="/display/~jdeolive" data-linked-resource-id="14894" data-linked-resource-type="userinfo" username="jdeolive" data-linked-resource-default-alias="Justin Deoliveira" data-base-url="http://docs.codehaus.org">Justin Deoliveira</a> +1</li><li><a class="confluence-link confluence-userlink" data-username="jive" href="/display/~jive" data-linked-resource-id="1159" data-linked-resource-type="userinfo" username="jive" data-linked-resource-default-alias="Jody Garnett" data-base-url="http://docs.codehaus.org">Jody Garnett</a> +1 (current OSGeo representative)</li><li><a class="confluence-link confluence-userlink" data-username="mbedward" href="/display/~mbedward" data-linked-resource-id="75366465" data-linked-resource-type="userinfo" username="mbedward" data-linked-resource-default-alias="Michael Bedward" data-base-url="http://docs.codehaus.org">Michael Bedward</a> +1</li><li><a class="confluence-link confluence-userlink" data-username="simboss" href="/display/~simboss" data-linked-resource-id="10743" data-linked-resource-type="userinfo" username="simboss" data-linked-resource-default-alias="Simone Giannecchini" data-base-url="http://docs.codehaus.org">Simone Giannecchini</a> +1</li></ul><h2>Tasks</h2><table class="confluenceTable"><tbody><tr><th class="confluenceTh"><p> </p></th><td class="confluenceTd"><p>no progress</p></td><th class="confluenceTh"><p><img class="emoticon emoticon-tick" data-emoticon-name="tick" border="0" src="/s/en_GB/3278/15/_/images/icons/emoticons/check.png" alt="(tick)" title="(tick)" /></p></th><td class="confluenceTd"><p>done</p></td><th class="confluenceTh"><p><img class="emoticon emoticon-cross" data-emoticon-name="cross" border="0" src="/s/en_GB/3278/15/_/images/icons/emoticons/error.png" alt="(error)" title="(error)" /></p></th><td class="confluenceTd"><p>impeded</p></td><th class="confluenceTh"><p><img class="emoticon emoticon-warning" data-emoticon-name="warning" border="0" src="/s/en_GB/3278/15/_/images/icons/emoticons/warning.png" alt="(warning)" title="(warning)" /></p></th><td class="confluenceTd"><p>lack mandate/funds/time</p></td><td class="confluenceTd"><p><img class="emoticon emoticon-question" data-emoticon-name="question" border="0" src="/s/en_GB/3278/15/_/images/icons/emoticons/help_16.png" alt="(question)" title="(question)" /></p></td><td class="confluenceTd"><p>volunteer needed</p></td></tr></tbody></table><ol><li>Reorganize docs in svn <img class="emoticon emoticon-tick" data-emoticon-name="tick" border="0" src="/s/en_GB/3278/15/_/images/icons/emoticons/check.png" alt="(tick)" title="(tick)" /></li><li>Add doc generation to maven build <img class="emoticon emoticon-tick" data-emoticon-name="tick" border="0" src="/s/en_GB/3278/15/_/images/icons/emoticons/check.png" alt="(tick)" title="(tick)" /></li><li>Update assembly to produce doc artifacts <img class="emoticon emoticon-tick" data-emoticon-name="tick" border="0" src="/s/en_GB/3278/15/_/images/icons/emoticons/check.png" alt="(tick)" title="(tick)" /></li><li>Add doc build to build server <img class="emoticon emoticon-tick" data-emoticon-name="tick" border="0" src="/s/en_GB/3278/15/_/images/icons/emoticons/check.png" alt="(tick)" title="(tick)" /></li><li>Modify doc build to push out new website on updates<img class="emoticon emoticon-tick" data-emoticon-name="tick" border="0" src="/s/en_GB/3278/15/_/images/icons/emoticons/check.png" alt="(tick)" title="(tick)" /></li><li>Port wiki content <img class="emoticon emoticon-tick" data-emoticon-name="tick" border="0" src="/s/en_GB/3278/15/_/images/icons/emoticons/check.png" alt="(tick)" title="(tick)" /></li></ol><h2>API Changes</h2><p>n/a</p><h2>Documentation Changes</h2><p>Docs currently living in <code>web</code> will be separated and moved into <code>docs</code>.</p>