path: root/doc/doc.txt

****************************
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

.. _Sphinx: http://sphinx.pocoo.org/
.. _numpydoc: http://pypi.python.org/pypi/numpydoc

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

.. _reStructuredText:
  http://docutils.sourceforge.net/docs/user/rst/quickref.html
.. _NumPy/SciPy documentation guide:
  https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt

Man page
========

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

The man page should conform to `Debian policy`_.

.. _Docutils: http://docutils.sourceforge.net/
.. _Debian policy:
  http://www.debian.org/doc/debian-policy/ch-docs.html