Producing this documentation

This documentation is written in reStructuredText, and produced using Sphinx and the numpydoc extension. The documentation source should be fairly readable without processing, but you can compile the documentation, you’ll need to install Sphinx and numpydoc:

$ easy_install Sphinx
$ easy_install numpydoc

See the reStructuredText quick reference and the NumPy/SciPy documentation guide for an introduction to the documentation syntax.

Man page

The man-page source be.1.txt is writen in reStructuredText. The Makefile converts it to roff(7) format using Docutils rst2man.

The man page should conform to Debian policy.

Table Of Contents

Previous topic


This Page