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