test/data/vclamp_jpk/README: Document sample versions
[hooke.git] / doc / doc.txt
index 319fe4dd85441527b230a49a2f529640bb85077e..335e88c3470e4e625fba49e6bd0a1d3f93ae8f5c 100644 (file)
@@ -5,7 +5,7 @@ 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 to compile the
-documentation, change to the ``doc/`` directory and run::
+documentation, change to the `doc/` directory and run::
 
     $ scons
 
@@ -20,9 +20,11 @@ For which you'll need to install Sphinx, numpydoc, and SCons_::
 
 See the reStructuredText quick reference and the `NumPy/SciPy
 documentation guide`_ for an introduction to the documentation
-syntax.
+syntax.  See the `Sphinx markup documentation`_ for a discussion
+of Sphinx's reStructuredText extensions.
 
 .. _reStructuredText:
   http://docutils.sourceforge.net/docs/user/rst/quickref.html
 .. _NumPy/SciPy documentation guide:
-  http://projects.scipy.org/numpy/wiki/CodingStyleGuidelines
+  https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt
+.. _Sphinx markup documentation: http://sphinx.pocoo.org/markup.html