Debian Codegraph @

docs/conf.py

raw
1 #
2 # Fiona documentation build configuration file, created by
3 # sphinx-quickstart on Mon Dec 26 12:16:26 2011.
4 #
5 # This file is execfile()d with the current directory set to its containing dir.
6 #
7 # Note that not all possible configuration values are present in this
8 # autogenerated file.
9 #
10 # All configuration values have a default; values that are commented out
11 # serve to show the default.
12
13 import sys, os
14
15 # If extensions (or modules to document with autodoc) are in another directory,
16 # add these directories to sys.path here. If the directory is relative to the
17 # documentation root, use os.path.abspath to make it absolute, like shown here.
18 # sys.path.insert(0, os.path.abspath('..'))
19
20 # -- General configuration -----------------------------------------------------
21
22 # If your documentation needs a minimal Sphinx version, state it here.
23 #needs_sphinx = '1.0'
24
25 # Add any Sphinx extension module names here, as strings. They can be extensions
26 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
27 extensions = [
28 'sphinx.ext.autodoc',
29 'sphinx.ext.doctest',
30 'sphinx.ext.intersphinx',
31 'sphinx.ext.napoleon',
32 'sphinx.ext.todo',
33 'sphinx_click',
34 ]
35
36 # Add any paths that contain templates here, relative to this directory.
37 templates_path = ['_templates']
38
39 # The suffix of source filenames.
40 source_suffix = '.rst'
41
42 # The encoding of source files.
43 #source_encoding = 'utf-8-sig'
44
45 # The master toctree document.
46 master_doc = 'index'
47
48 # General information about the project.
49 project = 'Fiona'
50 copyright = '2011, Sean Gillies'
51
52 # The version info for the project you're documenting, acts as replacement for
53 # |version| and |release|, also used in various other places throughout the
54 # built documents.
55
56 try:
57 release = fiona.__version__
58 except:
59 with open('../fiona/__init__.py') as f:
60 for line in f:
61 if line.find("__version__") >= 0:
62 version = line.split("=")[1].strip()
63 version = version.strip('"')
64 version = version.strip("'")
65 continue
66
67 # The language for content autogenerated by Sphinx. Refer to documentation
68 # for a list of supported languages.
69 #language = None
70
71 # There are two options for replacing |today|: either, you set today to some
72 # non-false value, then it is used:
73 #today = ''
74 # Else, today_fmt is used as the format for a strftime call.
75 #today_fmt = '%B %d, %Y'
76
77 # List of patterns, relative to source directory, that match files and
78 # directories to ignore when looking for source files.
79 exclude_patterns = ['_build']
80
81 # The reST default role (used for this markup: `text`) to use for all documents.
82 #default_role = None
83
84 # If true, '()' will be appended to :func: etc. cross-reference text.
85 #add_function_parentheses = True
86
87 # If true, the current module name will be prepended to all description
88 # unit titles (such as .. function::).
89 #add_module_names = True
90
91 # If true, sectionauthor and moduleauthor directives will be shown in the
92 # output. They are ignored by default.
93 #show_authors = False
94
95 # The name of the Pygments (syntax highlighting) style to use.
96 pygments_style = 'sphinx'
97
98 # A list of ignored prefixes for module index sorting.
99 #modindex_common_prefix = []
100
101
102 # -- Options for HTML output ---------------------------------------------------
103
104 # The theme to use for HTML and HTML Help pages. See the documentation for
105 # a list of builtin themes.
106 #html_theme = 'default'
107 #html_theme = 'sphinxdoc'
108 html_theme = 'sphinx_rtd_theme'
109
110 # Theme options are theme-specific and customize the look and feel of a theme
111 # further. For a list of options available for each theme, see the
112 # documentation.
113 #html_theme_options = {}
114
115 # Add any paths that contain custom themes here, relative to this directory.
116 #html_theme_path = []
117
118 # The name for this set of Sphinx documents. If None, it defaults to
119 # "<project> v<release> documentation".
120 #html_title = None
121
122 # A shorter title for the navigation bar. Default is the same as html_title.
123 #html_short_title = None
124
125 # The name of an image file (relative to this directory) to place at the top
126 # of the sidebar.
127 #html_logo = None
128
129 # The name of an image file (within the static path) to use as favicon of the
130 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
131 # pixels large.
132 #html_favicon = None
133
134 # Add any paths that contain custom static files (such as style sheets) here,
135 # relative to this directory. They are copied after the builtin static files,
136 # so a file named "default.css" will overwrite the builtin "default.css".
137 html_static_path = ['_static']
138
139 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
140 # using the given strftime format.
141 #html_last_updated_fmt = '%b %d, %Y'
142
143 # If true, SmartyPants will be used to convert quotes and dashes to
144 # typographically correct entities.
145 #html_use_smartypants = True
146
147 # Custom sidebar templates, maps document names to template names.
148 #html_sidebars = {}
149
150 # Additional templates that should be rendered to pages, maps page names to
151 # template names.
152 #html_additional_pages = {}
153
154 # If false, no module index is generated.
155 #html_domain_indices = True
156
157 # If false, no index is generated.
158 #html_use_index = True
159
160 # If true, the index is split into individual pages for each letter.
161 #html_split_index = False
162
163 # If true, links to the reST sources are added to the pages.
164 #html_show_sourcelink = True
165
166 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
167 #html_show_sphinx = True
168
169 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
170 #html_show_copyright = True
171
172 # If true, an OpenSearch description file will be output, and all pages will
173 # contain a <link> tag referring to it. The value of this option must be the
174 # base URL from which the finished HTML is served.
175 #html_use_opensearch = ''
176
177 # This is the file name suffix for HTML files (e.g. ".xhtml").
178 #html_file_suffix = None
179
180 # Output file base name for HTML help builder.
181 htmlhelp_basename = 'Fionadoc'
182
183
184 # -- Options for LaTeX output --------------------------------------------------
185
186 latex_elements = {
187 # The paper size ('letterpaper' or 'a4paper').
188 #'papersize': 'letterpaper',
189
190 # The font size ('10pt', '11pt' or '12pt').
191 #'pointsize': '10pt',
192
193 # Additional stuff for the LaTeX preamble.
194 #'preamble': '',
195 }
196
197 # Grouping the document tree into LaTeX files. List of tuples
198 # (source start file, target name, title, author, documentclass [howto/manual]).
199 latex_documents = [
200 ('index', 'Fiona.tex', 'Fiona Documentation',
201 'Sean Gillies', 'manual'),
202 ]
203
204 # The name of an image file (relative to this directory) to place at the top of
205 # the title page.
206 #latex_logo = None
207
208 # For "manual" documents, if this is true, then toplevel headings are parts,
209 # not chapters.
210 #latex_use_parts = False
211
212 # If true, show page references after internal links.
213 #latex_show_pagerefs = False
214
215 # If true, show URL addresses after external links.
216 #latex_show_urls = False
217
218 # Documents to append as an appendix to all manuals.
219 #latex_appendices = []
220
221 # If false, no module index is generated.
222 #latex_domain_indices = True
223
224
225 # -- Options for manual page output --------------------------------------------
226
227 # One entry per manual page. List of tuples
228 # (source start file, name, description, authors, manual section).
229 man_pages = [
230 ('index', 'fiona', 'Fiona Documentation',
231 ['Sean Gillies'], 1)
232 ]
233
234 # If true, show URL addresses after external links.
235 #man_show_urls = False
236
237
238 # -- Options for Texinfo output ------------------------------------------------
239
240 # Grouping the document tree into Texinfo files. List of tuples
241 # (source start file, target name, title, author,
242 # dir menu entry, description, category)
243 texinfo_documents = [
244 ('index', 'Fiona', 'Fiona Documentation',
245 'Sean Gillies', 'Fiona', 'One line description of project.',
246 'Miscellaneous'),
247 ]
248
249 # Documents to append as an appendix to all manuals.
250 #texinfo_appendices = []
251
252 # If false, no module index is generated.
253 #texinfo_domain_indices = True
254
255 # How to display URL addresses: 'footnote', 'no', or 'inline'.
256 #texinfo_show_urls = 'footnote'
257
258
259 # -- Options for Epub output ---------------------------------------------------
260
261 # Bibliographic Dublin Core info.
262 epub_title = 'Fiona'
263 epub_author = 'Sean Gillies'
264 epub_publisher = 'Sean Gillies'
265 epub_copyright = '2011, Sean Gillies'
266
267 # The language of the text. It defaults to the language option
268 # or en if the language is not set.
269 #epub_language = ''
270
271 # The scheme of the identifier. Typical schemes are ISBN or URL.
272 #epub_scheme = ''
273
274 # The unique identifier of the text. This can be a ISBN number
275 # or the project homepage.
276 #epub_identifier = ''
277
278 # A unique identification for the text.
279 #epub_uid = ''
280
281 # A tuple containing the cover image and cover page html template filenames.
282 #epub_cover = ()
283
284 # HTML files that should be inserted before the pages created by sphinx.
285 # The format is a list of tuples containing the path and title.
286 #epub_pre_files = []
287
288 # HTML files that should be inserted after the pages created by sphinx.
289 # The format is a list of tuples containing the path and title.
290 #epub_post_files = []
291
292 # A list of files that should not be packed into the epub file.
293 #epub_exclude_files = []
294
295 # The depth of the table of contents in toc.ncx.
296 #epub_tocdepth = 3
297
298 # Allow duplicate toc entries.
299 #epub_tocdup = True