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-2016, 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'
59 ('man1/notmuch','notmuch',
60 u'thread-based email index, search, and tagging',
61 [notmuch_authors], 1),
63 ('man1/notmuch-address','notmuch-address',
64 u'output addresses from matching messages',
65 [notmuch_authors], 1),
67 ('man1/notmuch-compact','notmuch-compact',
68 u'compact the notmuch database',
69 [notmuch_authors], 1),
71 ('man1/notmuch-config','notmuch-config',
72 u'access notmuch configuration file',
73 [notmuch_authors], 1),
75 ('man1/notmuch-count','notmuch-count',
76 u'count messages matching the given search terms',
77 [notmuch_authors], 1),
79 ('man1/notmuch-dump','notmuch-dump',
80 u'creates a plain-text dump of the tags of each message',
81 [notmuch_authors], 1),
83 ('man1/notmuch-emacs-mua','notmuch-emacs-mua',
84 u'send mail with notmuch and emacs',
85 [notmuch_authors], 1),
87 ('man5/notmuch-hooks','notmuch-hooks',
89 [notmuch_authors], 5),
91 ('man1/notmuch-insert','notmuch-insert',
92 u'add a message to the maildir and notmuch database',
93 [notmuch_authors], 1),
95 ('man1/notmuch-new','notmuch-new',
96 u'incorporate new mail into the notmuch database',
97 [notmuch_authors], 1),
99 ('man1/notmuch-reply','notmuch-reply',
100 u'constructs a reply template for a set of messages',
101 [notmuch_authors], 1),
103 ('man1/notmuch-restore','notmuch-restore',
104 u'restores the tags from the given file (see notmuch dump)',
105 [notmuch_authors], 1),
107 ('man1/notmuch-search','notmuch-search',
108 u'search for messages matching the given search terms',
109 [notmuch_authors], 1),
111 ('man7/notmuch-search-terms','notmuch-search-terms',
112 u'syntax for notmuch queries',
113 [notmuch_authors], 7),
115 ('man1/notmuch-show','notmuch-show',
116 u'show messages matching the given search terms',
117 [notmuch_authors], 1),
119 ('man1/notmuch-tag','notmuch-tag',
120 u'add/remove tags for all messages matching the search terms',
121 [notmuch_authors], 1),
125 # If true, show URL addresses after external links.
126 #man_show_urls = False
128 # -- Options for Texinfo output -------------------------------------------
130 # Grouping the document tree into Texinfo files. List of tuples
131 # (source start file, target name, title, author,
132 # dir menu entry, description, category)
133 # If true, do not generate a @detailmenu in the "Top" node's menu.
134 texinfo_no_detailmenu = True
136 texinfo_documents = [
137 ('notmuch-emacs', 'notmuch-emacs', u'notmuch Documentation',
138 notmuch_authors, 'notmuch-emacs',
139 'emacs based front-end for notmuch', 'Miscellaneous'),
142 # generate texinfo list from man page list
143 texinfo_documents += [
145 x[0], # source start file
147 u'notmuch Documentation', # title
149 x[1], # dir menu entry
151 'Miscellaneous' # category
152 ) for x in man_pages]