X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=doc%2Fconf.py;h=503255b5bb16e894699f17885146d13bf1d58b26;hb=fe3db23684c9de5b879733b7c7e3f7bbffbee026;hp=f01c005841c0f444cc65bbd54cf83bb408ca07ea;hpb=e50a413906b9fadf93b7801c4758b48792bb348f;p=notmuch diff --git a/doc/conf.py b/doc/conf.py index f01c0058..503255b5 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -3,8 +3,10 @@ import sys import os +from pathlib import Path +sys.path.append(str(Path(__file__).parent)) -extensions = [ 'sphinx.ext.autodoc' ] +extensions = [ 'sphinx.ext.autodoc', 'elisp' ] # The suffix of source filenames. source_suffix = '.rst' @@ -67,6 +69,8 @@ pygments_style = 'sphinx' # a list of builtin themes. html_theme = 'default' +# prevent generation of python module index +html_domain_indices=[] # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, @@ -127,6 +131,10 @@ man_pages = [ u'manage notmuch tags with git', [notmuch_authors], 1), + ('man1/notmuch-git', 'nmbug', + u'manage notmuch bugs with git', + [notmuch_authors], 1), + ('man5/notmuch-hooks', 'notmuch-hooks', u'hooks for notmuch', [notmuch_authors], 5), @@ -163,6 +171,10 @@ man_pages = [ u'syntax for notmuch queries', [notmuch_authors], 7), + ('man1/notmuch', 'notmuch-setup', + u'getting started with notmuch', + [notmuch_authors], 1), + ('man7/notmuch-sexp-queries', 'notmuch-sexp-queries', u's-expression syntax for notmuch queries', [notmuch_authors], 7), @@ -210,4 +222,14 @@ def setup(app): # define nmconfig role and directive for config items. app.add_object_type('nmconfig','nmconfig', indextemplate='pair: configuration item; %s', - ref_nodeclass=docutils.nodes.generated) + ref_nodeclass=docutils.nodes.generated, + objname='config item' ) + app.add_object_type('emacsvar','emacsvar', + indextemplate='pair: Emacs variable; %s', + ref_nodeclass=docutils.nodes.generated, + objname='Emacs variable') + app.add_object_type('emacscmd','emacscmd', + indextemplate='pair: Emacs command; %s', + ref_nodeclass=docutils.nodes.generated, + objname='Emacs command') +