2 # -*- coding: utf-8 -*-
7 # The suffix of source filenames.
10 # The master toctree document.
13 # General information about the project.
15 copyright = u'2009-2019, Carl Worth and many others'
17 location = os.path.dirname(__file__)
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','')
25 # The full version, including alpha/beta/rc tags.
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']
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')
38 # The name of the Pygments (syntax highlighting) style to use.
39 pygments_style = 'sphinx'
41 # -- Options for HTML output ----------------------------------------------
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'
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".
53 # Output file base name for HTML help builder.
54 htmlhelp_basename = 'notmuchdoc'
56 # Disable SmartyPants, as it mangles command lines.
57 # Despite the name, this actually affects manual pages as well.
58 html_use_smartypants = False
60 # -- Options for manual page output ---------------------------------------
62 # One entry per manual page. List of tuples
63 # (source start file, name, description, authors, manual section).
65 notmuch_authors = u'Carl Worth and many others'
68 ('man1/notmuch', 'notmuch',
69 u'thread-based email index, search, and tagging',
70 [notmuch_authors], 1),
72 ('man1/notmuch-address', 'notmuch-address',
73 u'output addresses from matching messages',
74 [notmuch_authors], 1),
76 ('man1/notmuch-compact', 'notmuch-compact',
77 u'compact the notmuch database',
78 [notmuch_authors], 1),
80 ('man1/notmuch-config', 'notmuch-config',
81 u'access notmuch configuration file',
82 [notmuch_authors], 1),
84 ('man1/notmuch-count', 'notmuch-count',
85 u'count messages matching the given search terms',
86 [notmuch_authors], 1),
88 ('man1/notmuch-dump', 'notmuch-dump',
89 u'creates a plain-text dump of the tags of each message',
90 [notmuch_authors], 1),
92 ('man1/notmuch-emacs-mua', 'notmuch-emacs-mua',
93 u'send mail with notmuch and emacs',
94 [notmuch_authors], 1),
96 ('man5/notmuch-hooks', 'notmuch-hooks',
98 [notmuch_authors], 5),
100 ('man1/notmuch-insert', 'notmuch-insert',
101 u'add a message to the maildir and notmuch database',
102 [notmuch_authors], 1),
104 ('man1/notmuch-new', 'notmuch-new',
105 u'incorporate new mail into the notmuch database',
106 [notmuch_authors], 1),
108 ('man7/notmuch-properties', 'notmuch-properties',
109 u'notmuch message property conventions and documentation',
110 [notmuch_authors], 7),
112 ('man1/notmuch-reindex', 'notmuch-reindex',
113 u're-index matching messages',
114 [notmuch_authors], 1),
116 ('man1/notmuch-reply', 'notmuch-reply',
117 u'constructs a reply template for a set of messages',
118 [notmuch_authors], 1),
120 ('man1/notmuch-restore', 'notmuch-restore',
121 u'restores the tags from the given file (see notmuch dump)',
122 [notmuch_authors], 1),
124 ('man1/notmuch-search', 'notmuch-search',
125 u'search for messages matching the given search terms',
126 [notmuch_authors], 1),
128 ('man7/notmuch-search-terms', 'notmuch-search-terms',
129 u'syntax for notmuch queries',
130 [notmuch_authors], 7),
132 ('man1/notmuch-show', 'notmuch-show',
133 u'show messages matching the given search terms',
134 [notmuch_authors], 1),
136 ('man1/notmuch-tag', 'notmuch-tag',
137 u'add/remove tags for all messages matching the search terms',
138 [notmuch_authors], 1),
141 # If true, show URL addresses after external links.
142 #man_show_urls = False
144 # -- Options for Texinfo output -------------------------------------------
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
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'),
158 # generate texinfo list from man page list
159 texinfo_documents += [
161 x[0], # source start file
163 x[1] + u' documentation', # title
165 x[1], # dir menu entry
167 'Miscellaneous' # category
168 ) for x in man_pages]