]> git.notmuchmail.org Git - notmuch/blobdiff - INSTALL
doc: convert sphinx based docs
[notmuch] / INSTALL
diff --git a/INSTALL b/INSTALL
index fce935289c4a360dd5802d5b20590e2cbefbdc10..690b0efd27eaa60b404d2ca72da11699d7dc9162 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -60,16 +60,30 @@ Talloc which are each described below:
 
        Talloc is available from http://talloc.samba.org/
 
+Building Documentation
+----------------------
+
+By default the documentation for notmuch is built using sphinx.
+
+Sphinx is available from www.sphinx-doc.org.
+
+If you prefer, you can build the man pages using rst2man, from the
+python docutils package. See doc/INSTALL for details.
+
+
+Installing Dependencies from Packages
+-------------------------------------
+
 On a modern, package-based operating system you can install all of the
 dependencies with a simple simple command line. For example:
 
   For Debian and similar:
 
-        sudo apt-get install libxapian-dev libgmime-2.6-dev libtalloc-dev
+        sudo apt-get install libxapian-dev libgmime-2.6-dev libtalloc-dev python-sphinx
 
   For Fedora and similar:
 
-       sudo yum install xapian-core-devel gmime-devel libtalloc-devel
+       sudo yum install xapian-core-devel gmime-devel libtalloc-devel python-sphinx
 
 On other systems, a similar command can be used, but the details of
 the package names may be different.