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'2014, 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 # -- Options for manual page output ---------------------------------------
  51
  52 # One entry per manual page. List of tuples
  53 # (source start file, name, description, authors, manual section).
  54
  55 man_pages = [
  56
  57 ('man1/notmuch','notmuch',
  58         u'thread-based email index, search, and tagging',
  59         [u'Carl Worth and many others'], 1),
  60
  61 ('man1/notmuch-compact','notmuch-compact',
  62         u'compact the notmuch database',
  63         [u'Carl Worth and many others'], 1),
  64
  65 ('man1/notmuch-config','notmuch-config',
  66         u'access notmuch configuration file',
  67         [u'Carl Worth and many others'], 1),
  68
  69 ('man1/notmuch-count','notmuch-count',
  70         u'count messages matching the given search terms',
  71         [u'Carl Worth and many others'], 1),
  72
  73 ('man1/notmuch-dump','notmuch-dump',
  74         u'creates a plain-text dump of the tags of each message',
  75         [u'Carl Worth and many others'], 1),
  76
  77 ('man5/notmuch-hooks','notmuch-hooks',
  78         u'hooks for notmuch',
  79         [u'Carl Worth and many others'], 5),
  80
  81 ('man1/notmuch-insert','notmuch-insert',
  82         u'add a message to the maildir and notmuch database',
  83         [u'Carl Worth and many others'], 1),
  84
  85 ('man1/notmuch-new','notmuch-new',
  86         u'incorporate new mail into the notmuch database',
  87         [u'Carl Worth and many others'], 1),
  88
  89 ('man1/notmuch-reply','notmuch-reply',
  90         u'constructs a reply template for a set of messages',
  91         [u'Carl Worth and many others'], 1),
  92
  93 ('man1/notmuch-restore','notmuch-restore',
  94         u'restores the tags from the given file (see notmuch dump)',
  95         [u'Carl Worth and many others'], 1),
  96
  97 ('man1/notmuch-search','notmuch-search',
  98         u'search for messages matching the given search terms',
  99         [u'Carl Worth and many others'], 1),
 100
 101 ('man7/notmuch-search-terms','notmuch-search-terms',
 102         u'syntax for notmuch queries',
 103         [u'Carl Worth and many others'], 7),
 104
 105 ('man1/notmuch-show','notmuch-show',
 106         u'show messages matching the given search terms',
 107         [u'Carl Worth and many others'], 1),
 108
 109 ('man1/notmuch-tag','notmuch-tag',
 110         u'add/remove tags for all messages matching the search terms',
 111         [u'Carl Worth and many others'], 1),
 112
 113
 114 ]
 115 # If true, show URL addresses after external links.
 116 #man_show_urls = False
 117
 118 # -- Options for Texinfo output -------------------------------------------
 119
 120 # Grouping the document tree into Texinfo files. List of tuples
 121 # (source start file, target name, title, author,
 122 #  dir menu entry, description, category)
 123 # If true, do not generate a @detailmenu in the "Top" node's menu.
 124 texinfo_no_detailmenu = True
 125
 126 texinfo_documents = [
 127  ('notmuch-emacs', 'notmuch-emacs', u'notmuch Documentation',
 128    u'Carl Worth and many others', 'notmuch-emacs',
 129    'emacs based front-end for notmuch', 'Miscellaneous'),
 130 ('man1/notmuch','notmuch',u'notmuch Documentation',
 131       u'Carl Worth and many others', 'notmuch',
 132       'thread-based email index, search, and tagging','Miscellaneous'),
 133 ('man1/notmuch-compact','notmuch-compact',u'notmuch Documentation',
 134       u'Carl Worth and many others', 'notmuch-compact',
 135       'compact the notmuch database','Miscellaneous'),
 136 ('man1/notmuch-config','notmuch-config',u'notmuch Documentation',
 137       u'Carl Worth and many others', 'notmuch-config',
 138       'access notmuch configuration file','Miscellaneous'),
 139 ('man1/notmuch-count','notmuch-count',u'notmuch Documentation',
 140       u'Carl Worth and many others', 'notmuch-count',
 141       'count messages matching the given search terms','Miscellaneous'),
 142 ('man1/notmuch-dump','notmuch-dump',u'notmuch Documentation',
 143       u'Carl Worth and many others', 'notmuch-dump',
 144       'creates a plain-text dump of the tags of each message','Miscellaneous'),
 145 ('man5/notmuch-hooks','notmuch-hooks',u'notmuch Documentation',
 146       u'Carl Worth and many others', 'notmuch-hooks',
 147       'hooks for notmuch','Miscellaneous'),
 148 ('man1/notmuch-insert','notmuch-insert',u'notmuch Documentation',
 149       u'Carl Worth and many others', 'notmuch-insert',
 150       'add a message to the maildir and notmuch database','Miscellaneous'),
 151 ('man1/notmuch-new','notmuch-new',u'notmuch Documentation',
 152       u'Carl Worth and many others', 'notmuch-new',
 153       'incorporate new mail into the notmuch database','Miscellaneous'),
 154 ('man1/notmuch-reply','notmuch-reply',u'notmuch Documentation',
 155       u'Carl Worth and many others', 'notmuch-reply',
 156       'constructs a reply template for a set of messages','Miscellaneous'),
 157 ('man1/notmuch-restore','notmuch-restore',u'notmuch Documentation',
 158       u'Carl Worth and many others', 'notmuch-restore',
 159       'restores the tags from the given file (see notmuch dump)','Miscellaneous'),
 160 ('man1/notmuch-search','notmuch-search',u'notmuch Documentation',
 161       u'Carl Worth and many others', 'notmuch-search',
 162       'search for messages matching the given search terms','Miscellaneous'),
 163 ('man7/notmuch-search-terms','notmuch-search-terms',u'notmuch Documentation',
 164       u'Carl Worth and many others', 'notmuch-search-terms',
 165       'syntax for notmuch queries','Miscellaneous'),
 166 ('man1/notmuch-show','notmuch-show',u'notmuch Documentation',
 167       u'Carl Worth and many others', 'notmuch-show',
 168       'show messages matching the given search terms','Miscellaneous'),
 169 ('man1/notmuch-tag','notmuch-tag',u'notmuch Documentation',
 170       u'Carl Worth and many others', 'notmuch-tag',
 171       'add/remove tags for all messages matching the search terms','Miscellaneous'),
 172 ]