Documentation for the patacrep project, using Sphinx.
This documentation may be read online on Read the Docs.
To build the documentation, you will need a
make implementation and sphinx. Sphinx can be installed with
pip, or very likely with the package manager of your distribution.
You will need a working LaTeX distribution.
The main language of the documentation is French. English version is also available, and can be build with the following steps :
gettext, or make sure you have it.
- Create the
- Update the
sphinx-intl update -p _build/locale -l en
- Translate the
- Build the HTML version with
make -e SPHINXOPTS="-D language='en'" html
- Build the PDF version with
make -e SPHINXOPTS="-D language='en'" latexpdf
When the French documentation is updated, restart at step 3.
A compiled PDF version should be available, someday, here : http://www.patacrep.com/data/documents/doc_fr.pdf