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-2017, 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 # The name of the Pygments (syntax highlighting) style to use.
33 pygments_style = 'sphinx'
35 # -- Options for HTML output ----------------------------------------------
37 # The theme to use for HTML and HTML Help pages. See the documentation for
38 # a list of builtin themes.
39 html_theme = 'default'
42 # Add any paths that contain custom static files (such as style sheets) here,
43 # relative to this directory. They are copied after the builtin static files,
44 # so a file named "default.css" will overwrite the builtin "default.css".
47 # Output file base name for HTML help builder.
48 htmlhelp_basename = 'notmuchdoc'
50 # -- Options for manual page output ---------------------------------------
52 # One entry per manual page. List of tuples
53 # (source start file, name, description, authors, manual section).
55 notmuch_authors = u'Carl Worth and many others'
58 ('man1/notmuch', 'notmuch',
59 u'thread-based email index, search, and tagging',
60 [notmuch_authors], 1),
62 ('man1/notmuch-address', 'notmuch-address',
63 u'output addresses from matching messages',
64 [notmuch_authors], 1),
66 ('man1/notmuch-compact', 'notmuch-compact',
67 u'compact the notmuch database',
68 [notmuch_authors], 1),
70 ('man1/notmuch-config', 'notmuch-config',
71 u'access notmuch configuration file',
72 [notmuch_authors], 1),
74 ('man1/notmuch-count', 'notmuch-count',
75 u'count messages matching the given search terms',
76 [notmuch_authors], 1),
78 ('man1/notmuch-dump', 'notmuch-dump',
79 u'creates a plain-text dump of the tags of each message',
80 [notmuch_authors], 1),
82 ('man1/notmuch-emacs-mua', 'notmuch-emacs-mua',
83 u'send mail with notmuch and emacs',
84 [notmuch_authors], 1),
86 ('man5/notmuch-hooks', 'notmuch-hooks',
88 [notmuch_authors], 5),
90 ('man1/notmuch-insert', 'notmuch-insert',
91 u'add a message to the maildir and notmuch database',
92 [notmuch_authors], 1),
94 ('man1/notmuch-new', 'notmuch-new',
95 u'incorporate new mail into the notmuch database',
96 [notmuch_authors], 1),
98 ('man1/notmuch-reply', 'notmuch-reply',
99 u'constructs a reply template for a set of messages',
100 [notmuch_authors], 1),
102 ('man1/notmuch-restore', 'notmuch-restore',
103 u'restores the tags from the given file (see notmuch dump)',
104 [notmuch_authors], 1),
106 ('man1/notmuch-search', 'notmuch-search',
107 u'search for messages matching the given search terms',
108 [notmuch_authors], 1),
110 ('man7/notmuch-search-terms', 'notmuch-search-terms',
111 u'syntax for notmuch queries',
112 [notmuch_authors], 7),
114 ('man1/notmuch-show', 'notmuch-show',
115 u'show messages matching the given search terms',
116 [notmuch_authors], 1),
118 ('man1/notmuch-tag', 'notmuch-tag',
119 u'add/remove tags for all messages matching the search terms',
120 [notmuch_authors], 1),
123 # If true, show URL addresses after external links.
124 #man_show_urls = False
126 # -- Options for Texinfo output -------------------------------------------
128 # Grouping the document tree into Texinfo files. List of tuples
129 # (source start file, target name, title, author,
130 # dir menu entry, description, category)
131 # If true, do not generate a @detailmenu in the "Top" node's menu.
132 texinfo_no_detailmenu = True
134 texinfo_documents = [
135 ('notmuch-emacs', 'notmuch-emacs', u'notmuch-emacs documentation',
136 notmuch_authors, 'notmuch-emacs',
137 'emacs based front-end for notmuch', 'Miscellaneous'),
140 # generate texinfo list from man page list
141 texinfo_documents += [
143 x[0], # source start file
145 x[1] + u' documentation', # title
147 x[1], # dir menu entry
149 'Miscellaneous' # category
150 ) for x in man_pages]