X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=doc%2Fconf.py;h=ee1b336af2ad61d36336c5891b821cf201915560;hb=HEAD;hp=7f94cbed4d1c57da1d972e5225bce7dc36c74f8e;hpb=3cb936b7c458bc9b0f5cc6d7fb266307fd0224d8;p=notmuch diff --git a/doc/conf.py b/doc/conf.py index 7f94cbed..1cc9961e 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' @@ -14,7 +16,7 @@ master_doc = 'index' # General information about the project. project = u'notmuch' -copyright = u'2009-2022, Carl Worth and many others' +copyright = u'2009-2025, Carl Worth and many others' location = os.path.dirname(__file__) @@ -45,7 +47,7 @@ if tags.has('WITH_EMACS'): # Hacky reimplementation of include to workaround limitations of # sphinx-doc lines = ['.. include:: /../emacs/rstdoc.rsti\n\n'] # in the source tree - for file in ('notmuch.rsti', 'notmuch-lib.rsti', 'notmuch-hello.rsti', 'notmuch-show.rsti', 'notmuch-tag.rsti', 'notmuch-tree.rsti'): + for file in ('notmuch.rsti', 'notmuch-lib.rsti', 'notmuch-hello.rsti', 'notmuch-show.rsti', 'notmuch-tag.rsti', 'notmuch-tree.rsti', 'notmuch-maildir-fcc.rsti'): lines.extend(open(rsti_dir+'/'+file)) rst_epilog = ''.join(lines) del lines @@ -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, @@ -218,4 +222,5 @@ 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' )