X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=doc%2Fconf.py;h=ffb8ca1f662dca056af2075bf75a383daf72d5ae;hp=a3d8269696a366dca12b1caa4a8d67e6005d993c;hb=ee8dba1c3013a00c0d1185583ea084f8ce3699b7;hpb=a34f30888e7874fba2032a066a7babce1dd3f69f diff --git a/doc/conf.py b/doc/conf.py index a3d82696..ffb8ca1f 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -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' @@ -47,6 +63,10 @@ html_static_path = [] # Output file base name for HTML help builder. htmlhelp_basename = 'notmuchdoc' +# Disable SmartyPants, as it mangles command lines. +# Despite the name, this actually affects manual pages as well. +html_use_smartypants = False + # -- Options for manual page output --------------------------------------- # One entry per manual page. List of tuples @@ -95,6 +115,14 @@ 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), + ('man1/notmuch-reply', 'notmuch-reply', u'constructs a reply template for a set of messages', [notmuch_authors], 1),