Added Sphinx documentation framework

[hooke.git] / doc / doc.txt

diff --git a/doc/doc.txt b/doc/doc.txt
new file mode 100644 (file)
index 0000000..319fe4d
--- /dev/null
+++ b/doc/doc.txt
@@ -0,0 +1,28 @@
+****************************
+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::
+
+    $ scons
+
+For which you'll need to install Sphinx, numpydoc, and SCons_::
+
+    $ easy_install Sphinx
+    $ easy_install numpydoc
+
+.. _Sphinx: http://sphinx.pocoo.org/
+.. _numpydoc: http://pypi.python.org/pypi/numpydoc
+.. _SCons: http://www.scons.org/
+
+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:
+  http://projects.scipy.org/numpy/wiki/CodingStyleGuidelines