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