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).
57 ('man1/notmuch','notmuch',
58 u'thread-based email index, search, and tagging',
59 [u'Carl Worth and many others'], 1),
61 ('man1/notmuch-address','notmuch-address',
62 u'output addresses from matching messages',
63 [u'Carl Worth and many others'], 1),
65 ('man1/notmuch-compact','notmuch-compact',
66 u'compact the notmuch database',
67 [u'Carl Worth and many others'], 1),
69 ('man1/notmuch-config','notmuch-config',
70 u'access notmuch configuration file',
71 [u'Carl Worth and many others'], 1),
73 ('man1/notmuch-count','notmuch-count',
74 u'count messages matching the given search terms',
75 [u'Carl Worth and many others'], 1),
77 ('man1/notmuch-dump','notmuch-dump',
78 u'creates a plain-text dump of the tags of each message',
79 [u'Carl Worth and many others'], 1),
81 ('man1/notmuch-emacs-mua','notmuch-emacs-mua',
82 u'send mail with notmuch and emacs',
83 [u'Carl Worth and many others'], 1),
85 ('man5/notmuch-hooks','notmuch-hooks',
87 [u'Carl Worth and many others'], 5),
89 ('man1/notmuch-insert','notmuch-insert',
90 u'add a message to the maildir and notmuch database',
91 [u'Carl Worth and many others'], 1),
93 ('man1/notmuch-new','notmuch-new',
94 u'incorporate new mail into the notmuch database',
95 [u'Carl Worth and many others'], 1),
97 ('man1/notmuch-reply','notmuch-reply',
98 u'constructs a reply template for a set of messages',
99 [u'Carl Worth and many others'], 1),
101 ('man1/notmuch-restore','notmuch-restore',
102 u'restores the tags from the given file (see notmuch dump)',
103 [u'Carl Worth and many others'], 1),
105 ('man1/notmuch-search','notmuch-search',
106 u'search for messages matching the given search terms',
107 [u'Carl Worth and many others'], 1),
109 ('man7/notmuch-search-terms','notmuch-search-terms',
110 u'syntax for notmuch queries',
111 [u'Carl Worth and many others'], 7),
113 ('man1/notmuch-show','notmuch-show',
114 u'show messages matching the given search terms',
115 [u'Carl Worth and many others'], 1),
117 ('man1/notmuch-tag','notmuch-tag',
118 u'add/remove tags for all messages matching the search terms',
119 [u'Carl Worth and many others'], 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 Documentation',
136 u'Carl Worth and many others', '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 u'notmuch Documentation', # title
147 x[1], # dir menu entry
149 'Miscellaneous' # category
150 ) for x in man_pages]