1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
|
# Sphinx configuration file
import sys, os
# Avoid useless botan_version.pyc (Python 2.6 or higher)
if 'dont_write_bytecode' in sys.__dict__:
sys.dont_write_bytecode = True
sys.path.insert(0, os.pardir)
import sphinx
import botan_version
def check_for_tag(tag):
# Nasty hack :(
try:
opt_t = sys.argv.index('-t')
opt_tag = sys.argv.index(tag)
return opt_t + 1 == opt_tag
except ValueError:
return False
is_website_build = check_for_tag('website')
use_disqus = is_website_build and check_for_tag('disqus')
needs_sphinx = '1.0'
"""
Assert that we are running under Sphinx 1.0.7 or later. Earlier
versions have bugs in the C++ domain that cause crashes. And
needs_sphinx only allows us to assert needing a particular major/minor
version.
"""
def check_sphinx_version():
import sphinx
version = map(int, sphinx.__version__.split('.'))
if version[0] == 1 and version[1] == 0 and version[2] < 7:
# Exit rather than throwing to avoid a confusing backtrace
print "This Sphinx is too old - upgrade to at least 1.0.7"
sys.exit(1)
check_sphinx_version()
extensions = ['sphinx.ext.extlinks']
templates_path = ['_sphinx/templates']
if is_website_build and use_disqus:
templates_path += ['_sphinx/disqus']
extlinks = {
'pr': ('http://bugs.randombit.net/show_bug.cgi?id=%s', 'PR '),
'tgz': ('http://botan.randombit.net/files/Botan-%s.tgz', 'tar/gz for '),
'tgz_sig': ('http://botan.randombit.net/files/Botan-%s.tgz.asc', 'tar/gz sig '),
'tbz': ('http://botan.randombit.net/files/Botan-%s.tbz', 'tar/bzip for '),
'tbz_sig': ('http://botan.randombit.net/files/Botan-%s.tbz.asc', 'tar/bzip sig '),
'wikipedia': ('http://en.wikipedia.org/wiki/%s', ''),
'viewmtn': ('http://viewmtn.randombit.net/tree/h:%s', ''),
'botan-devel': ('http://lists.randombit.net/pipermail/botan-devel/%s.html', None),
'installer_x86_32': ('http://botan.randombit.net/files/win32/botan-%s_win32.exe',
'x86-32 '),
'installer_x86_64': ('http://botan.randombit.net/files/win32/botan-%s_win64.exe',
'x86-64 ')
}
source_suffix = '.rst'
source_encoding = 'utf-8-sig'
master_doc = 'contents'
project = u'botan'
copyright = u'2000-2012, Jack Lloyd'
version = '%d.%d' % (botan_version.release_major, botan_version.release_minor)
release = '%d.%d.%d' % (botan_version.release_major,
botan_version.release_minor,
botan_version.release_patch)
#today = ''
today_fmt = '%Y-%m-%d'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = []
# The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
add_function_parentheses = False
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False
highlight_language = 'cpp'
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
# -- Options for HTML output ---------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'agogo'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
html_theme_options = {
'linkcolor': 'blue',
'headerlinkcolor': 'blue',
'headercolor1': 'darkblue',
'headercolor2': 'darkblue',
'textalign': 'left'
}
# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
html_title = 'Botan'
# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#html_favicon = None
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = []
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
html_last_updated_fmt = '%Y-%m-%d'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}
# If false, no module index is generated.
#html_domain_indices = True
# If false, no index is generated.
#html_use_index = True
# If true, the index is split into individual pages for each letter.
#html_split_index = False
# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
html_show_sphinx = False
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
html_show_copyright = False
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
if is_website_build:
html_use_opensearch = 'http://botan.randombit.net/'
else:
html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None
# Output file base name for HTML help builder.
htmlhelp_basename = 'botandoc'
# -- Options for LaTeX output --------------------------------------------------
# The paper size ('letter' or 'a4').
#latex_paper_size = 'letter'
# The font size ('10pt', '11pt' or '12pt').
#latex_font_size = '10pt'
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
('contents', 'botan.tex', u'botan Reference Manual',
u'Jack Lloyd', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False
# If true, show page references after internal links.
latex_show_pagerefs = False
# If true, show URL addresses after external links.
latex_show_urls = False
# Additional stuff for the LaTeX preamble.
#latex_preamble = ''
# Documents to append as an appendix to all manuals.
#latex_appendices = []
# If false, no module index is generated.
#latex_domain_indices = True
|