lp:~timmie/+junk/osgeo-edu_sphinxexample
*******
Proposal for a common documentation workflow
*******
Motivation
==============
OSGEO intends to create a common repository for the mutual creation and edition of
documentation, tutorials and teaching materials.
A common format can facilitate the collaborative editing as a format and editing system known
to all editors and usable by everyone regardsles of the operation system, preferred editor or
workflow has the following advantages:
* lower the entrance barrier for possible contributors
* reduce the number of formatting errors
* automise the buil and creation of final documents
A simple format: Restructured Text (ReST)
=======
Restructured Text is a markup format mainly used in the documentation of software and
especially adopted as standard for Python docstrings.
Advantages
-------
* simple text format
* no styling
* widely adopted in the open-source programming world
* converter into various export formats (latex, html, odf) exist
* `pandoc <http://
* native: rst2html, rst2s5, rst2odp, rst2latex
* additional: rst2beamer, rst2odt, rst2pdf
* easy to create screen presentations from the documents
* easy to import or include in academic publications through LaTex/LyX
Support
-------
* `Emacs: see docutils page <http://
* `Gedit (Linux) <http://
* `Ulipad (Win) <http://
Alternative Formats
=======
* Lyx which also support export to
* PDF
* HTML
* ODT
A versatile build system: Sphinx
=======
Introduction
-------
The documentation creation and build system `Sphinx <http://
on ReST as input format and uses its simple structure together with the `docutils <http://
conversion utilities to offer a flexible documentation system.
It is used to prepare the documentation of one of the major scripting languages: `Python <http://
More and more `software projects <http://
for their documentation; and while most of them are using Python, other programming
languages are also supported.
Advantages
-------
* as being the documentation tool for Python, contious development is ensured
* well documented
* a supportive user mailing list
* a `simple webinterface <http://
and a more advanced is
`in development <http://
* editing is simple and accessible as ReST is used (see above)
* content is mostely separated from layout and styling
* theming support for layout and styling
* configurable content depending on output format
* supports markup suited for documentaion and software tutorials such as
* equations
* code highlighting
* literature citations are cared for and rudimentary bibtex plugin exists
* by consisting only of text files it is easy to include into a version control system
* the final documentation can be built into html or PDF among others
* can be build automatically with python distutils or any other build system
Examples
-------
* An example of a community written book using Sphinx: Python3 Patterns
* http://
* http://
* It is maintained in a DVCS: http://
- Get this branch:
- bzr branch lp:~timmie/+junk/osgeo-edu_sphinxexample
Branch information
- Owner:
- Timmie
- Status:
- Development
Recent revisions
Branch metadata
- Branch format:
- Branch format 6
- Repository format:
- Bazaar pack repository format 1 (needs bzr 0.92)