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