]> git.notmuchmail.org Git - notmuch/blobdiff - doc/conf.py
doc: fix for out-of-tree builds of notmuch-emacs docs
[notmuch] / doc / conf.py
index 0e65413d917aec68b71c8314b280e7f729de661a..ffb8ca1f662dca056af2075bf75a383daf72d5ae 100644 (file)
@@ -12,7 +12,7 @@ master_doc = 'index'
 
 # General information about the project.
 project = u'notmuch'
-copyright = u'2009-2017, Carl Worth and many others'
+copyright = u'2009-2019, Carl Worth and many others'
 
 location = os.path.dirname(__file__)
 
@@ -29,6 +29,22 @@ release = version
 # directories to ignore when looking for source files.
 exclude_patterns = ['_build']
 
+if os.environ.get('WITH_EMACS') == '1':
+    # Hacky reimplementation of include to workaround limitations of
+    # sphinx-doc
+    lines = ['.. include:: /../emacs/rstdoc.rsti\n\n'] # in the source tree
+    rsti_dir = os.environ.get('RSTI_DIR')
+    # the other files are from the build tree
+    for file in ('notmuch.rsti', 'notmuch-lib.rsti', 'notmuch-show.rsti', 'notmuch-tag.rsti'):
+        lines.extend(open(rsti_dir+'/'+file))
+    rst_epilog = ''.join(lines)
+    del lines
+else:
+    # If we don't have emacs (or the user configured --without-emacs),
+    # don't build the notmuch-emacs docs, as they need emacs to generate
+    # the docstring include files
+    exclude_patterns.append('notmuch-emacs.rst')
+
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
 
@@ -99,6 +115,10 @@ man_pages = [
      u'incorporate new mail into the notmuch database',
      [notmuch_authors], 1),
 
+    ('man7/notmuch-properties', 'notmuch-properties',
+     u'notmuch message property conventions and documentation',
+     [notmuch_authors], 7),
+
     ('man1/notmuch-reindex', 'notmuch-reindex',
      u're-index matching messages',
      [notmuch_authors], 1),