Documentation de projets python

! en cours de rédaction !

Sphinx

Sphinx est outil de documentation propre à Python, il peut générer de la documentation à partir du code source (docstrings), mais ne restreint pas la documentation a ce qu'on peut trouver dans le code.

Utilisation

Déjà, il faut l'installer:

# apt-get install python-sphinx

Si la version est trop vieille, passer par pip ou easy_install:

# pip install sphinx

# easy_install sphinx

Ensuite, dans le dossier du projet:

$ sphinx-quickstart

Exemple:

$ sphinx-quickstart 
Welcome to the Sphinx quickstart utility.

Please enter values for the following settings (just press Enter to
accept a default value, if one is given in brackets).

Enter the root path for documentation.
> Root path for the documentation [.]: doc

You have two options for placing the build directory for Sphinx output.
Either, you use a directory "_build" within the root path, or you separate
"source" and "build" directories within the root path.
> Separate source and build directories (y/N) [n]: n

Inside the root directory, two more directories will be created; "_templates"
for custom HTML templates and "_static" for custom stylesheets and other static
files. You can enter another prefix (such as ".") to replace the underscore.
> Name prefix for templates and static dir [_]: _

The project name will occur in several places in the built documentation.
> Project name: auf_projet
> Author name(s): Cyril Robert

Sphinx has the notion of a "version" and a "release" for the
software. Each version can have multiple releases. For example, for
Python the version is something like 2.5 or 3.0, while the release is
something like 2.5.1 or 3.0a1.  If you don't need this dual structure,
just set both to the same value.
> Project version: 0.0
> Project release [0.0]: 

The file name suffix for source files. Commonly, this is either ".txt"
or ".rst".  Only files with this suffix are considered documents.
> Source file suffix [.rst]: .rst

One document is special in that it is considered the top node of the
"contents tree", that is, it is the root of the hierarchical structure
of the documents. Normally, this is "index", but if your "index"
document is a custom template, you can also set this to another filename.
> Name of your master document (without suffix) [index]: index

Please indicate if you want to use one of the following Sphinx extensions:
> autodoc: automatically insert docstrings from modules (y/N) [n]: y
> doctest: automatically test code snippets in doctest blocks (y/N) [n]: n
> intersphinx: link between Sphinx documentation of different projects (y/N) [n]: n
> todo: write "todo" entries that can be shown or hidden on build (y/N) [n]: n
> coverage: checks for documentation coverage (y/N) [n]: y
> pngmath: include math, rendered as PNG images (y/N) [n]: n
> jsmath: include math, rendered in the browser by JSMath (y/N) [n]: n
> ifconfig: conditional inclusion of content based on config values (y/N) [n]: n

A Makefile and a Windows command file can be generated for you so that you
only have to run e.g. `make html' instead of invoking sphinx-build
directly.
> Create Makefile? (Y/n) [y]: y
> Create Windows command file? (Y/n) [y]: n

Finished: An initial directory structure has been created.

You should now populate your master file doc/index.rst and create other documentation
source files. Use the Makefile to build the docs, like so:
   make builder
where "builder" is one of the supported builders, e.g. html, latex or linkcheck.

Il faut ensuite apporter quelques changements à conf.py:

1. Trouver la ligne:

   •     #sys.path.append(os.path.abspath('.'))

     La décommenter, et remplacer '.' par le chemin vers le projet:

         sys.path.append(os.path.abspath('../auf_projet'))

2. On peut définir la version d'après le setup.py ou un autre fichier:
   • Trouver les lignes

         version = '0.0'
         release = '0.0'

     Les remplacer par (par exemple)

         import setup
         version = setup.version
         release = version

On peut ensuite construire la documentation:

$ make html
  ...
$ firefox _build/html/index.html

Guide sur la syntaxe du format rst: http://sphinx.pocoo.org/latest/rest.html

Truc: Pour documenter un module sur une page

.. automodule:: module.sousmodule
  :synopsis: sous-module de machin
  :members: Classes, ou_methodes