git.notmuchmail.org Git - notmuch/blob - doc/INSTALL

   1 This file contains some more detailed information about building and
   2 installing the documentation.
   3
   4 Building with sphinx.
   5 ---------------------
   6
   7 - You need sphinx at least version 1.0.
   8
   9 - You can build build and install man pages with 'make install-man'
  10
  11 - You can build man, info, html, and pdf versions of the docs
  12   (currently only the man pages) with
  13
  14      'make install-{man|info|html|pdf}'
  15
  16 Building the man pages
  17 ----------------------
  18
  19 - You can build the man pages with rst2man (from python-docutils) with
  20   'make rst2man'.
  21
  22 - Currently there is no support to automagically install the resulting
  23   nroff files, but it should work to modify the target install-man
  24   in doc/Makefile.local.