Sphinx és una eina de documentació específicament pensada per a documentar programari tot i que també pot ser aplicada en altres àmbits. Es una aplicació escrita en Python i extensible en base a plugins (i.e. amb plugins es pot estendre la seva funcionalitat).
En essència permet construir i mantenir la documentació associada a un projecte de programari a partir de dues fonts d’informació:
- Un conjunt de fitxers en format reST.
- El codi font del propi projecte i els docstrings que aquest contingui.
El resultat us semblarà familiar atès que és l’eina emprada per mantenir la documentació de Python que esteu acostumats a usar.
Per usar l’eina cal seguir un esquema de tres passos:
- Establir l’entorn de treball.
- Escriure la documentació i definir l’entorn.
- Generar la documentació resultant.
Com podeu veure en essència es tracta d’un generador, per això sovint aquest tipus d’eines se les anomena generadors de documentació. La documentació generada pot estar en diversos formats, segons convingui. Per exemple en HTML o en PDF. Aquesta forma de treball és molt convenient atès que els diferents formats de sortida es generen a partir d’un unic original amb el conseqüent estalvi de temps i garantia de coherència.
Per establir l’entorn de treball usem la comanda sphinx-quickstart que de manera interactiva va preguntant com volem configurar l’entorn de generació de la docuemntació. Una sessió típica pot tenir aquest aspecte:
S'ha iniciat l'execució de script a dj 03 feb 2011 20:40:23 CET
sebas@bubinga:/tmp$ sphinx-quickstart
Welcome to the Sphinx 1.0.7 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]: y
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: Reductio
> Author name(s): S. Vila-Marta
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: 1.0
> Project release [1.0]: 1.0b2
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]:
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]:
Sphinx can also add configuration for epub output:
> Do you want to use the epub builder (y/N) [n]:
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]:
> intersphinx: link between Sphinx documentation of different projects (y/N) [n]:
> todo: write "todo" entries that can be shown or hidden on build (y/N) [n]:
> coverage: checks for documentation coverage (y/N) [n]:
> pngmath: include math, rendered as PNG images (y/N) [n]:
> jsmath: include math, rendered in the browser by JSMath (y/N) [n]:
> ifconfig: conditional inclusion of content based on config values (y/N) [n]:
> viewcode: include links to the source code of documented Python objects (y/N) [n]: y
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]:
> Create Windows command file? (Y/n) [y]: n
Finished: An initial directory structure has been created
You should now populate your master file doc/source/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.
sebas@bubinga: /tmp$
Aquesta comanda crea una estructura de directoris dins de doc preparada per a rebre la documentació. El directori principal és doc/source, que és el que contindrà els fitxers reST amb el gruix de la documentació original o font. El directori doc/build contindrà la documentació generada en el format de sortida.