This file contains some more detailed information about building and
installing the documentation.
-Building with sphinx.
----------------------
+Building with Sphinx
+--------------------
-- You need sphinx at least version 1.0.
+With Sphinx_ version 1.0 or greater, you can build man, info, html,
+and pdf versions of the docs (currently only the man pages) with::
-- You can build build and install man pages with 'make install-man'
+ make build-{man|info|html|pdf}
-- You can build man, info, html, and pdf versions of the docs
- (currently only the man pages) with
+You can build build and install the docs (currently only the man
+pages) with::
- 'make install-{man|info|html|pdf}'
+ make install-{man|info|html|pdf}
-Building the man pages
-----------------------
+Building the man Docutils
+-------------------------
-- You can build the man pages with rst2man (from python-docutils) with
- 'make rst2man'.
+If you don't have Sphinx installed, you can still build the man-page
+version of the docs using rst2man (from Docutils_)::
-- Currently there is no support to automagically install the resulting
- nroff files, but it should work to modify the target install-man
- in doc/Makefile.local.
+ make build-man
+
+and install with::
+
+ make install-man
+
+.. _Sphinx: http://sphinx-doc.org/
+.. _Docutils: http://docutils.sourceforge.net/