doc/doc.txt

   1 ****************************
   2 Producing this documentation
   3 ****************************
   4
   5 This documentation is written in reStructuredText_, and produced using
   6 Sphinx_ and the numpydoc_ extension.  The documentation source should
   7 be fairly readable without processing, but to compile the
   8 documentation, change to the `doc/` directory and run::
   9
  10     $ scons
  11
  12 For which you'll need to install Sphinx, numpydoc, and SCons_::
  13
  14     $ easy_install Sphinx
  15     $ easy_install numpydoc
  16
  17 .. _Sphinx: http://sphinx.pocoo.org/
  18 .. _numpydoc: http://pypi.python.org/pypi/numpydoc
  19 .. _SCons: http://www.scons.org/
  20
  21 See the reStructuredText quick reference and the `NumPy/SciPy
  22 documentation guide`_ for an introduction to the documentation
  23 syntax.  See the `Sphinx markup documentation`_ for a discussion
  24 of Sphinx's reStructuredText extensions.
  25
  26 .. _reStructuredText:
  27   http://docutils.sourceforge.net/docs/user/rst/quickref.html
  28 .. _NumPy/SciPy documentation guide:
  29   https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt
  30 .. _Sphinx markup documentation: http://sphinx.pocoo.org/markup.html