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

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