doc/sexp: document range queries.
[notmuch] / doc / conf.py
1
2 # -*- coding: utf-8 -*-
3
4 import sys
5 import os
6
7 extensions = [ 'sphinx.ext.autodoc' ]
8
9 # The suffix of source filenames.
10 source_suffix = '.rst'
11
12 # The master toctree document.
13 master_doc = 'index'
14
15 # General information about the project.
16 project = u'notmuch'
17 copyright = u'2009-2022, Carl Worth and many others'
18
19 location = os.path.dirname(__file__)
20
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','')
26
27 # for autodoc
28 sys.path.insert(0, os.path.join(location, '..', 'bindings', 'python-cffi', 'build', 'stage'))
29
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()))
36
37 # The full version, including alpha/beta/rc tags.
38 release = version
39
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']
43
44 if tags.has('WITH_EMACS'):
45     # Hacky reimplementation of include to workaround limitations of
46     # sphinx-doc
47     lines = ['.. include:: /../emacs/rstdoc.rsti\n\n'] # in the source tree
48     for file in ('notmuch.rsti', 'notmuch-lib.rsti', 'notmuch-hello.rsti', 'notmuch-show.rsti', 'notmuch-tag.rsti', 'notmuch-tree.rsti'):
49         lines.extend(open(rsti_dir+'/'+file))
50     rst_epilog = ''.join(lines)
51     del lines
52 else:
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')
57
58 if not tags.has('WITH_PYTHON'):
59     exclude_patterns.append('python-bindings.rst')
60
61 # The name of the Pygments (syntax highlighting) style to use.
62 pygments_style = 'sphinx'
63
64 # -- Options for HTML output ----------------------------------------------
65
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'
69
70
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".
74 html_static_path = []
75
76 # Output file base name for HTML help builder.
77 htmlhelp_basename = 'notmuchdoc'
78
79 # Disable SmartyPants, as it mangles command lines.
80 # Despite the name, this actually affects manual pages as well.
81 html_use_smartypants = False
82
83 # See:
84 # - https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-manpages_url
85 # - https://manpages.debian.org/
86 manpages_url = 'https://manpages.debian.org/{page}.{section}.html'
87
88 # -- Options for manual page output ---------------------------------------
89
90 # One entry per manual page. List of tuples
91 # (source start file, name, description, authors, manual section).
92
93 notmuch_authors = u'Carl Worth and many others'
94
95 man_make_section_directory = False
96
97 man_pages = [
98     ('man1/notmuch', 'notmuch',
99      u'thread-based email index, search, and tagging',
100      [notmuch_authors], 1),
101
102     ('man1/notmuch-address', 'notmuch-address',
103      u'output addresses from matching messages',
104      [notmuch_authors], 1),
105
106     ('man1/notmuch-compact', 'notmuch-compact',
107      u'compact the notmuch database',
108      [notmuch_authors], 1),
109
110     ('man1/notmuch-config', 'notmuch-config',
111      u'access notmuch configuration file',
112      [notmuch_authors], 1),
113
114     ('man1/notmuch-count', 'notmuch-count',
115      u'count messages matching the given search terms',
116      [notmuch_authors], 1),
117
118     ('man1/notmuch-dump', 'notmuch-dump',
119      u'creates a plain-text dump of the tags of each message',
120      [notmuch_authors], 1),
121
122     ('man1/notmuch-emacs-mua', 'notmuch-emacs-mua',
123      u'send mail with notmuch and emacs',
124      [notmuch_authors], 1),
125
126     ('man1/notmuch-git', 'notmuch-git',
127      u'manage notmuch tags with git',
128      [notmuch_authors], 1),
129
130     ('man5/notmuch-hooks', 'notmuch-hooks',
131      u'hooks for notmuch',
132      [notmuch_authors], 5),
133
134     ('man1/notmuch-insert', 'notmuch-insert',
135      u'add a message to the maildir and notmuch database',
136      [notmuch_authors], 1),
137
138     ('man1/notmuch-new', 'notmuch-new',
139      u'incorporate new mail into the notmuch database',
140      [notmuch_authors], 1),
141
142     ('man7/notmuch-properties', 'notmuch-properties',
143      u'notmuch message property conventions and documentation',
144      [notmuch_authors], 7),
145
146     ('man1/notmuch-reindex', 'notmuch-reindex',
147      u're-index matching messages',
148      [notmuch_authors], 1),
149
150     ('man1/notmuch-reply', 'notmuch-reply',
151      u'constructs a reply template for a set of messages',
152      [notmuch_authors], 1),
153
154     ('man1/notmuch-restore', 'notmuch-restore',
155      u'restores the tags from the given file (see notmuch dump)',
156      [notmuch_authors], 1),
157
158     ('man1/notmuch-search', 'notmuch-search',
159      u'search for messages matching the given search terms',
160      [notmuch_authors], 1),
161
162     ('man7/notmuch-search-terms', 'notmuch-search-terms',
163      u'syntax for notmuch queries',
164      [notmuch_authors], 7),
165
166     ('man7/notmuch-sexp-queries', 'notmuch-sexp-queries',
167      u's-expression syntax for notmuch queries',
168      [notmuch_authors], 7),
169
170     ('man1/notmuch-show', 'notmuch-show',
171      u'show messages matching the given search terms',
172      [notmuch_authors], 1),
173
174     ('man1/notmuch-tag', 'notmuch-tag',
175      u'add/remove tags for all messages matching the search terms',
176      [notmuch_authors], 1),
177 ]
178
179 # If true, show URL addresses after external links.
180 #man_show_urls = False
181
182 # -- Options for Texinfo output -------------------------------------------
183
184 # Grouping the document tree into Texinfo files. List of tuples
185 # (source start file, target name, title, author,
186 #  dir menu entry, description, category)
187 # If true, do not generate a @detailmenu in the "Top" node's menu.
188 texinfo_no_detailmenu = True
189
190 texinfo_documents = [
191     ('notmuch-emacs', 'notmuch-emacs', u'notmuch-emacs documentation',
192      notmuch_authors, 'notmuch-emacs',
193      'emacs based front-end for notmuch', 'Miscellaneous'),
194 ]
195
196 # generate texinfo list from man page list
197 texinfo_documents += [
198     (
199         x[0],                           # source start file
200         x[1],                           # target name
201         x[1] + u' documentation',       # title
202         x[3][0],                        # author
203         x[1],                           # dir menu entry
204         x[2],                           # description
205         'Miscellaneous'                 # category
206     ) for x in man_pages]
207
208 def setup(app):
209     import docutils.nodes
210     # define nmconfig role and directive for config items.
211     app.add_object_type('nmconfig','nmconfig',
212                         indextemplate='pair: configuration item; %s',
213                         ref_nodeclass=docutils.nodes.generated)