doc/doc.txt

   1 ****************************
   2 Producing this documentation
   3 ****************************
   4
   5 This documentation is written in reStructuredText_, and produced
   6 using Sphinx_ and the numpydoc_ extension.  The documentation source
   7 should be fairly readable without processing, but you can compile the
   8 documentation, you'll need to install Sphinx and numpydoc::
   9
  10     $ easy_install Sphinx
  11     $ easy_install numpydoc
  12
  13 .. _Sphinx: http://sphinx.pocoo.org/
  14 .. _numpydoc: http://pypi.python.org/pypi/numpydoc
  15
  16 See the reStructuredText quick reference and the `NumPy/SciPy
  17 documentation guide`_ for an introduction to the documentation
  18 syntax.
  19
  20 .. _reStructuredText:
  21   http://docutils.sourceforge.net/docs/user/rst/quickref.html
  22 .. _NumPy/SciPy documentation guide:
  23   https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt
  24
  25 Man page
  26 ========
  27
  28 The man-page source :file:`be.1.txt` is writen in reStructuredText.
  29 The :file:`Makefile` converts it to :manpage:`roff(7)` format using
  30 Docutils_ ``rst2man``.
  31
  32 The man page should conform to `Debian policy`_.
  33
  34 .. _Docutils: http://docutils.sourceforge.net/
  35 .. _Debian policy:
  36   http://www.debian.org/doc/debian-policy/ch-docs.html