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