3cec01451f359e86609efe58fa89356188531860
[notmuch] / doc / conf.py
1
2 # -*- coding: utf-8 -*-
3
4 import sys
5 import os
6
7 # The suffix of source filenames.
8 source_suffix = '.rst'
9
10 # The master toctree document.
11 master_doc = 'index'
12
13 # General information about the project.
14 project = u'notmuch'
15 copyright = u'2009-2016, Carl Worth and many others'
16
17 location = os.path.dirname(__file__)
18
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','')
24
25 # The full version, including alpha/beta/rc tags.
26 release = version
27
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']
31
32 # The name of the Pygments (syntax highlighting) style to use.
33 pygments_style = 'sphinx'
34
35 # -- Options for HTML output ----------------------------------------------
36
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'
40
41
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".
45 html_static_path = []
46
47 # Output file base name for HTML help builder.
48 htmlhelp_basename = 'notmuchdoc'
49
50 # -- Options for manual page output ---------------------------------------
51
52 # One entry per manual page. List of tuples
53 # (source start file, name, description, authors, manual section).
54
55 notmuch_authors = u'Carl Worth and many others'
56
57 man_pages = [
58
59 ('man1/notmuch','notmuch',
60         u'thread-based email index, search, and tagging',
61         [notmuch_authors], 1),
62
63 ('man1/notmuch-address','notmuch-address',
64         u'output addresses from matching messages',
65         [notmuch_authors], 1),
66
67 ('man1/notmuch-compact','notmuch-compact',
68         u'compact the notmuch database',
69         [notmuch_authors], 1),
70
71 ('man1/notmuch-config','notmuch-config',
72         u'access notmuch configuration file',
73         [notmuch_authors], 1),
74
75 ('man1/notmuch-count','notmuch-count',
76         u'count messages matching the given search terms',
77         [notmuch_authors], 1),
78
79 ('man1/notmuch-dump','notmuch-dump',
80         u'creates a plain-text dump of the tags of each message',
81         [notmuch_authors], 1),
82
83 ('man1/notmuch-emacs-mua','notmuch-emacs-mua',
84         u'send mail with notmuch and emacs',
85         [notmuch_authors], 1),
86
87 ('man5/notmuch-hooks','notmuch-hooks',
88         u'hooks for notmuch',
89         [notmuch_authors], 5),
90
91 ('man1/notmuch-insert','notmuch-insert',
92         u'add a message to the maildir and notmuch database',
93         [notmuch_authors], 1),
94
95 ('man1/notmuch-new','notmuch-new',
96         u'incorporate new mail into the notmuch database',
97         [notmuch_authors], 1),
98
99 ('man1/notmuch-reply','notmuch-reply',
100         u'constructs a reply template for a set of messages',
101         [notmuch_authors], 1),
102
103 ('man1/notmuch-restore','notmuch-restore',
104         u'restores the tags from the given file (see notmuch dump)',
105         [notmuch_authors], 1),
106
107 ('man1/notmuch-search','notmuch-search',
108         u'search for messages matching the given search terms',
109         [notmuch_authors], 1),
110
111 ('man7/notmuch-search-terms','notmuch-search-terms',
112         u'syntax for notmuch queries',
113         [notmuch_authors], 7),
114
115 ('man1/notmuch-show','notmuch-show',
116         u'show messages matching the given search terms',
117         [notmuch_authors], 1),
118
119 ('man1/notmuch-tag','notmuch-tag',
120         u'add/remove tags for all messages matching the search terms',
121         [notmuch_authors], 1),
122
123
124 ]
125 # If true, show URL addresses after external links.
126 #man_show_urls = False
127
128 # -- Options for Texinfo output -------------------------------------------
129
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
135
136 texinfo_documents = [
137  ('notmuch-emacs', 'notmuch-emacs', u'notmuch Documentation',
138    notmuch_authors, 'notmuch-emacs',
139    'emacs based front-end for notmuch', 'Miscellaneous'),
140 ]
141
142 # generate texinfo list from man page list
143 texinfo_documents += [
144     (
145         x[0],                           # source start file
146         x[1],                           # target name
147         u'notmuch Documentation',       # title
148         x[3][0],                        # author
149         x[1],                           # dir menu entry
150         x[2],                           # description
151         'Miscellaneous'                 # category
152     ) for x in man_pages]