git.cworth.org Git - notmuch/blob - doc/conf.py

   1
   2 # -*- coding: utf-8 -*-
   3
   4 import sys
   5 import os
   6
   7 extensions = [ 'sphinx.ext.autodoc' ]
   8
   9 # The suffix of source filenames.
  10 source_suffix = '.rst'
  11
  12 # The master toctree document.
  13 master_doc = 'index'
  14
  15 # General information about the project.
  16 project = u'notmuch'
  17 copyright = u'2009-2022, Carl Worth and many others'
  18
  19 location = os.path.dirname(__file__)
  20
  21 for pathdir in ['.', '..']:
  22     version_file = os.path.join(location,pathdir,'version.txt')
  23     if os.path.exists(version_file):
  24         with open(version_file,'r') as infile:
  25             version=infile.read().replace('\n','')
  26
  27 # for autodoc
  28 sys.path.insert(0, os.path.join(location, '..', 'bindings', 'python-cffi', 'build', 'stage'))
  29
  30 # read generated config
  31 for pathdir in ['.', '..']:
  32     conf_file = os.path.join(location,pathdir,'sphinx.config')
  33     if os.path.exists(conf_file):
  34         with open(conf_file,'r') as infile:
  35             exec(''.join(infile.readlines()))
  36
  37 # The full version, including alpha/beta/rc tags.
  38 release = version
  39
  40 # List of patterns, relative to source directory, that match files and
  41 # directories to ignore when looking for source files.
  42 exclude_patterns = ['_build']
  43
  44 if tags.has('WITH_EMACS'):
  45     # Hacky reimplementation of include to workaround limitations of
  46     # sphinx-doc
  47     lines = ['.. include:: /../emacs/rstdoc.rsti\n\n'] # in the source tree
  48     for file in ('notmuch.rsti', 'notmuch-lib.rsti', 'notmuch-show.rsti', 'notmuch-tag.rsti', 'notmuch-tree.rsti'):
  49         lines.extend(open(rsti_dir+'/'+file))
  50     rst_epilog = ''.join(lines)
  51     del lines
  52 else:
  53     # If we don't have emacs (or the user configured --without-emacs),
  54     # don't build the notmuch-emacs docs, as they need emacs to generate
  55     # the docstring include files
  56     exclude_patterns.append('notmuch-emacs.rst')
  57
  58 if not tags.has('WITH_PYTHON'):
  59     exclude_patterns.append('python-bindings.rst')
  60
  61 # The name of the Pygments (syntax highlighting) style to use.
  62 pygments_style = 'sphinx'
  63
  64 # -- Options for HTML output ----------------------------------------------
  65
  66 # The theme to use for HTML and HTML Help pages.  See the documentation for
  67 # a list of builtin themes.
  68 html_theme = 'default'
  69
  70
  71 # Add any paths that contain custom static files (such as style sheets) here,
  72 # relative to this directory. They are copied after the builtin static files,
  73 # so a file named "default.css" will overwrite the builtin "default.css".
  74 html_static_path = []
  75
  76 # Output file base name for HTML help builder.
  77 htmlhelp_basename = 'notmuchdoc'
  78
  79 # Disable SmartyPants, as it mangles command lines.
  80 # Despite the name, this actually affects manual pages as well.
  81 html_use_smartypants = False
  82
  83 # See:
  84 # - https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-manpages_url
  85 # - https://manpages.debian.org/
  86 manpages_url = 'https://manpages.debian.org/{page}.{section}.html'
  87
  88 # -- Options for manual page output ---------------------------------------
  89
  90 # One entry per manual page. List of tuples
  91 # (source start file, name, description, authors, manual section).
  92
  93 notmuch_authors = u'Carl Worth and many others'
  94
  95 man_make_section_directory = False
  96
  97 man_pages = [
  98     ('man1/notmuch', 'notmuch',
  99      u'thread-based email index, search, and tagging',
 100      [notmuch_authors], 1),
 101
 102     ('man1/notmuch-address', 'notmuch-address',
 103      u'output addresses from matching messages',
 104      [notmuch_authors], 1),
 105
 106     ('man1/notmuch-compact', 'notmuch-compact',
 107      u'compact the notmuch database',
 108      [notmuch_authors], 1),
 109
 110     ('man1/notmuch-config', 'notmuch-config',
 111      u'access notmuch configuration file',
 112      [notmuch_authors], 1),
 113
 114     ('man1/notmuch-count', 'notmuch-count',
 115      u'count messages matching the given search terms',
 116      [notmuch_authors], 1),
 117
 118     ('man1/notmuch-dump', 'notmuch-dump',
 119      u'creates a plain-text dump of the tags of each message',
 120      [notmuch_authors], 1),
 121
 122     ('man1/notmuch-emacs-mua', 'notmuch-emacs-mua',
 123      u'send mail with notmuch and emacs',
 124      [notmuch_authors], 1),
 125
 126     ('man5/notmuch-hooks', 'notmuch-hooks',
 127      u'hooks for notmuch',
 128      [notmuch_authors], 5),
 129
 130     ('man1/notmuch-insert', 'notmuch-insert',
 131      u'add a message to the maildir and notmuch database',
 132      [notmuch_authors], 1),
 133
 134     ('man1/notmuch-new', 'notmuch-new',
 135      u'incorporate new mail into the notmuch database',
 136      [notmuch_authors], 1),
 137
 138     ('man7/notmuch-properties', 'notmuch-properties',
 139      u'notmuch message property conventions and documentation',
 140      [notmuch_authors], 7),
 141
 142     ('man1/notmuch-reindex', 'notmuch-reindex',
 143      u're-index matching messages',
 144      [notmuch_authors], 1),
 145
 146     ('man1/notmuch-reply', 'notmuch-reply',
 147      u'constructs a reply template for a set of messages',
 148      [notmuch_authors], 1),
 149
 150     ('man1/notmuch-restore', 'notmuch-restore',
 151      u'restores the tags from the given file (see notmuch dump)',
 152      [notmuch_authors], 1),
 153
 154     ('man1/notmuch-search', 'notmuch-search',
 155      u'search for messages matching the given search terms',
 156      [notmuch_authors], 1),
 157
 158     ('man7/notmuch-search-terms', 'notmuch-search-terms',
 159      u'syntax for notmuch queries',
 160      [notmuch_authors], 7),
 161
 162     ('man7/notmuch-sexp-queries', 'notmuch-sexp-queries',
 163      u's-expression syntax for notmuch queries',
 164      [notmuch_authors], 7),
 165
 166     ('man1/notmuch-show', 'notmuch-show',
 167      u'show messages matching the given search terms',
 168      [notmuch_authors], 1),
 169
 170     ('man1/notmuch-tag', 'notmuch-tag',
 171      u'add/remove tags for all messages matching the search terms',
 172      [notmuch_authors], 1),
 173 ]
 174
 175 # If true, show URL addresses after external links.
 176 #man_show_urls = False
 177
 178 # -- Options for Texinfo output -------------------------------------------
 179
 180 # Grouping the document tree into Texinfo files. List of tuples
 181 # (source start file, target name, title, author,
 182 #  dir menu entry, description, category)
 183 # If true, do not generate a @detailmenu in the "Top" node's menu.
 184 texinfo_no_detailmenu = True
 185
 186 texinfo_documents = [
 187     ('notmuch-emacs', 'notmuch-emacs', u'notmuch-emacs documentation',
 188      notmuch_authors, 'notmuch-emacs',
 189      'emacs based front-end for notmuch', 'Miscellaneous'),
 190 ]
 191
 192 # generate texinfo list from man page list
 193 texinfo_documents += [
 194     (
 195         x[0],                           # source start file
 196         x[1],                           # target name
 197         x[1] + u' documentation',       # title
 198         x[3][0],                        # author
 199         x[1],                           # dir menu entry
 200         x[2],                           # description
 201         'Miscellaneous'                 # category
 202     ) for x in man_pages]