diff options
author | David Bremner <david@tethera.net> | 2014-01-28 12:12:37 -0400 |
---|---|---|
committer | David Bremner <david@tethera.net> | 2014-03-09 10:41:08 -0300 |
commit | d736260385a689b5c77d8121f48e29440e3adfa4 (patch) | |
tree | 4d5c4279405a012f6f312fbb8c003226c618bb78 /doc/INSTALL | |
parent | 029790d3ff6e9fccfed2214efac777b8c438e318 (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 'doc/INSTALL')
-rw-r--r-- | doc/INSTALL | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/doc/INSTALL b/doc/INSTALL new file mode 100644 index 00000000..e37c2b9b --- /dev/null +++ b/doc/INSTALL @@ -0,0 +1,24 @@ +This file contains some more detailed information about building and +installing the documentation. + +Building with sphinx. +--------------------- + +- You need sphinx at least version 1.0. + +- You can build build and install man pages with 'make install-man' + +- You can build man, info, html, and pdf versions of the docs + (currently only the man pages) with + + 'make install-{man|info|html|pdf}' + +Building the man pages +---------------------- + +- You can build the man pages with rst2man (from python-docutils) with + 'make rst2man'. + +- 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. |