We use Sphinx to build the user manual. It's located in the docs/ directory of the repository.
FIXME - lots of stuff to add here regarding conventions, ...
To build, do:
cd docs/ make html
The HTML version of the docs will then be in docs/_build/html/.
To build, you need to use the latest tip from Sphinx in hg to build the manual into a Texinfo file. The texinfo builder/writer haven't been released in a final Sphinx release, yet. To get a copy, you need to do an hg clone:
You need to install it. I install it in a virtual environment:
mkvirtualenv sphinxtip cd sphinx/ python setup.py develop
After you have a copy of the latest Sphinx in hg installed, run:
cd docs/ make info
The Texinfo version of the docs will then be in docs/_build/texinfo/.
To test, open up Emacs and do C-u C-h i and then select the .info file. Read through it, make sure the images are correct and that there aren't weird things. Note that you need to use a graphical Emacs and not a command shell Emacs.