2 # -*- coding: utf-8 -*-
7 extensions = [ 'sphinx.ext.autodoc' ]
9 # The suffix of source filenames.
10 source_suffix = '.rst'
12 # The master toctree document.
15 # General information about the project.
17 copyright = u'2009-2021, Carl Worth and many others'
19 location = os.path.dirname(__file__)
21 for pathdir in ['.', '..']:
22 version_file = os.path.join(location,pathdir,'version.txt')
23 if os.path.exists(version_file):
24 with open(version_file,'r') as infile:
25 version=infile.read().replace('\n','')
28 sys.path.insert(0, os.path.join(location, '..', 'bindings', 'python-cffi', 'notmuch2'))
30 # read generated config
31 for pathdir in ['.', '..']:
32 conf_file = os.path.join(location,pathdir,'sphinx.config')
33 if os.path.exists(conf_file):
34 with open(conf_file,'r') as infile:
35 exec(''.join(infile.readlines()))
37 # The full version, including alpha/beta/rc tags.
40 # List of patterns, relative to source directory, that match files and
41 # directories to ignore when looking for source files.
42 exclude_patterns = ['_build']
44 if tags.has('WITH_EMACS'):
45 # Hacky reimplementation of include to workaround limitations of
47 lines = ['.. include:: /../emacs/rstdoc.rsti\n\n'] # in the source tree
48 for file in ('notmuch.rsti', 'notmuch-lib.rsti', 'notmuch-show.rsti', 'notmuch-tag.rsti'):
49 lines.extend(open(rsti_dir+'/'+file))
50 rst_epilog = ''.join(lines)
53 # If we don't have emacs (or the user configured --without-emacs),
54 # don't build the notmuch-emacs docs, as they need emacs to generate
55 # the docstring include files
56 exclude_patterns.append('notmuch-emacs.rst')
58 if not tags.has('WITH_PYTHON'):
59 exclude_patterns.append('python-bindings.rst')
61 # The name of the Pygments (syntax highlighting) style to use.
62 pygments_style = 'sphinx'
64 # -- Options for HTML output ----------------------------------------------
66 # The theme to use for HTML and HTML Help pages. See the documentation for
67 # a list of builtin themes.
68 html_theme = 'default'
71 # Add any paths that contain custom static files (such as style sheets) here,
72 # relative to this directory. They are copied after the builtin static files,
73 # so a file named "default.css" will overwrite the builtin "default.css".
76 # Output file base name for HTML help builder.
77 htmlhelp_basename = 'notmuchdoc'
79 # Disable SmartyPants, as it mangles command lines.
80 # Despite the name, this actually affects manual pages as well.
81 html_use_smartypants = False
83 # -- Options for manual page output ---------------------------------------
85 # One entry per manual page. List of tuples
86 # (source start file, name, description, authors, manual section).
88 notmuch_authors = u'Carl Worth and many others'
90 man_make_section_directory = False
93 ('man1/notmuch', 'notmuch',
94 u'thread-based email index, search, and tagging',
95 [notmuch_authors], 1),
97 ('man1/notmuch-address', 'notmuch-address',
98 u'output addresses from matching messages',
99 [notmuch_authors], 1),
101 ('man1/notmuch-compact', 'notmuch-compact',
102 u'compact the notmuch database',
103 [notmuch_authors], 1),
105 ('man1/notmuch-config', 'notmuch-config',
106 u'access notmuch configuration file',
107 [notmuch_authors], 1),
109 ('man1/notmuch-count', 'notmuch-count',
110 u'count messages matching the given search terms',
111 [notmuch_authors], 1),
113 ('man1/notmuch-dump', 'notmuch-dump',
114 u'creates a plain-text dump of the tags of each message',
115 [notmuch_authors], 1),
117 ('man1/notmuch-emacs-mua', 'notmuch-emacs-mua',
118 u'send mail with notmuch and emacs',
119 [notmuch_authors], 1),
121 ('man5/notmuch-hooks', 'notmuch-hooks',
122 u'hooks for notmuch',
123 [notmuch_authors], 5),
125 ('man1/notmuch-insert', 'notmuch-insert',
126 u'add a message to the maildir and notmuch database',
127 [notmuch_authors], 1),
129 ('man1/notmuch-new', 'notmuch-new',
130 u'incorporate new mail into the notmuch database',
131 [notmuch_authors], 1),
133 ('man7/notmuch-properties', 'notmuch-properties',
134 u'notmuch message property conventions and documentation',
135 [notmuch_authors], 7),
137 ('man1/notmuch-reindex', 'notmuch-reindex',
138 u're-index matching messages',
139 [notmuch_authors], 1),
141 ('man1/notmuch-reply', 'notmuch-reply',
142 u'constructs a reply template for a set of messages',
143 [notmuch_authors], 1),
145 ('man1/notmuch-restore', 'notmuch-restore',
146 u'restores the tags from the given file (see notmuch dump)',
147 [notmuch_authors], 1),
149 ('man1/notmuch-search', 'notmuch-search',
150 u'search for messages matching the given search terms',
151 [notmuch_authors], 1),
153 ('man7/notmuch-search-terms', 'notmuch-search-terms',
154 u'syntax for notmuch queries',
155 [notmuch_authors], 7),
157 ('man1/notmuch-show', 'notmuch-show',
158 u'show messages matching the given search terms',
159 [notmuch_authors], 1),
161 ('man1/notmuch-tag', 'notmuch-tag',
162 u'add/remove tags for all messages matching the search terms',
163 [notmuch_authors], 1),
166 # If true, show URL addresses after external links.
167 #man_show_urls = False
169 # -- Options for Texinfo output -------------------------------------------
171 # Grouping the document tree into Texinfo files. List of tuples
172 # (source start file, target name, title, author,
173 # dir menu entry, description, category)
174 # If true, do not generate a @detailmenu in the "Top" node's menu.
175 texinfo_no_detailmenu = True
177 texinfo_documents = [
178 ('notmuch-emacs', 'notmuch-emacs', u'notmuch-emacs documentation',
179 notmuch_authors, 'notmuch-emacs',
180 'emacs based front-end for notmuch', 'Miscellaneous'),
183 # generate texinfo list from man page list
184 texinfo_documents += [
186 x[0], # source start file
188 x[1] + u' documentation', # title
190 x[1], # dir menu entry
192 'Miscellaneous' # category
193 ) for x in man_pages]