sphinx documentation process - STEMLab/geotools GitHub Wiki

• Motivation: Finalize sphinx documentation practice

• Contact: Justin Deoliveira

• Tracker: https://osgeo-org.atlassian.net/browse/GEOT-3114

• Tagline: Sphinx documentation process

Description

This proposal outlines a process for generating and managing project documentation with Sphinx.

Doc Organization

Documentation will be organized into three categories:

#. user guide
#. developer guide
#. web site

And reorganized in svn as follows:

trunk/
  docs/
    devel/
    user/
    web/
  modules/
  ...

Doc Generation

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.

Doc Assembly

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.

Doc Continuous Build

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.

Status

Completed.

Voting:

• Andrea Aime +1

• Ben Caradoc-Davies +1

• Christian Mueller +1

• Ian Turton +1

• Justin Deoliveira +1

• Jody Garnett +1 (current OSGeo representative)

• Michael Bedward +1

• Simone Giannecchini +1

      | :white_check_mark: | :no_entry: | :warning:               | :negative_squared_cross_mark: |
  

------------|--------------------|------------|-------------------------|-------------------------------| no progress | done | impeded | lack mandate/funds/time | volunteer needed |

1. Reorganize docs in svn :white_check_mark:
2. Add doc generation to maven build :white_check_mark:
3. Update assembly to produce doc artifacts :white_check_mark:
4. Add doc build to build server :white_check_mark:
5. Modify doc build to push out new website on updates:white_check_mark:
6. Port wiki content :white_check_mark:

API Changes

n/a

Documentation Changes

Docs currently living in web will be separated and moved into docs.