aboutsummaryrefslogtreecommitdiffhomepage
path: root/INSTALL
diff options
context:
space:
mode:
authorGravatar David Bremner <david@tethera.net>2014-01-28 12:12:37 -0400
committerGravatar David Bremner <david@tethera.net>2014-03-09 10:41:08 -0300
commitd736260385a689b5c77d8121f48e29440e3adfa4 (patch)
tree4d5c4279405a012f6f312fbb8c003226c618bb78 /INSTALL
parent029790d3ff6e9fccfed2214efac777b8c438e318 (diff)
doc: convert sphinx based docs
This is the output from sphinx-quickstart, massaged a bit, along with our existing man pages converted to rst. A skeleton notmuch-emacs manual is also included. It is not suitable for end user use yet.
Diffstat (limited to 'INSTALL')
-rw-r--r--INSTALL18
1 files changed, 16 insertions, 2 deletions
diff --git a/INSTALL b/INSTALL
index fce93528..690b0efd 100644
--- 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.