]> code.communitydata.science - rises_declines_wikia_code.git/blob - mediawiki_dump_tools/Mediawiki-Utilities/doc/conf.py
add copy of the GPL
[rises_declines_wikia_code.git] / mediawiki_dump_tools / Mediawiki-Utilities / doc / conf.py
1 #!/usr/bin/env python3
2 # -*- coding: utf-8 -*-
3 #
4 # mediawiki-utilities documentation build configuration file, created by
5 # sphinx-quickstart on Thu Apr 10 17:31:47 2014.
6 #
7 # This file is execfile()d with the current directory set to its
8 # containing dir.
9 #
10 # Note that not all possible configuration values are present in this
11 # autogenerated file.
12 #
13 # All configuration values have a default; values that are commented out
14 # serve to show the default.
15
16 import sys
17 import os
18
19 # If extensions (or modules to document with autodoc) are in another directory,
20 # add these directories to sys.path here. If the directory is relative to the
21 # documentation root, use os.path.abspath to make it absolute, like shown here.
22 sys.path.insert(0, os.path.abspath('../'))
23 import mw
24
25 # -- General configuration ------------------------------------------------
26
27 # If your documentation needs a minimal Sphinx version, state it here.
28 #needs_sphinx = '1.0'
29
30 # Add any Sphinx extension module names here, as strings. They can be
31 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
32 # ones.
33 extensions = [
34     'sphinx.ext.autodoc',
35     'sphinx.ext.doctest',
36     'sphinx.ext.todo',
37     'sphinx.ext.coverage',
38     'sphinx.ext.mathjax',
39     'sphinx.ext.viewcode',
40 ]
41
42 # Add any paths that contain templates here, relative to this directory.
43 templates_path = ['_templates']
44
45 # The suffix of source filenames.
46 source_suffix = '.rst'
47
48 # The encoding of source files.
49 #source_encoding = 'utf-8-sig'
50
51 # The master toctree document.
52 master_doc = 'index'
53
54 # General information about the project.
55 project = 'mediawiki-utilities'
56 copyright = '2014, Aaron Halfaker'
57
58 # The version info for the project you're documenting, acts as replacement for
59 # |version| and |release|, also used in various other places throughout the
60 # built documents.
61 #
62 # The short X.Y version.
63 version = mw.__version__
64 # The full version, including alpha/beta/rc tags.
65 release = mw.__version__
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
82 # documents.
83 #default_role = None
84
85 # If true, '()' will be appended to :func: etc. cross-reference text.
86 #add_function_parentheses = True
87
88 # If true, the current module name will be prepended to all description
89 # unit titles (such as .. function::).
90 #add_module_names = True
91
92 # If true, sectionauthor and moduleauthor directives will be shown in the
93 # output. They are ignored by default.
94 #show_authors = False
95
96 # The name of the Pygments (syntax highlighting) style to use.
97 pygments_style = 'sphinx'
98
99 # A list of ignored prefixes for module index sorting.
100 #modindex_common_prefix = []
101
102 # If true, keep warnings as "system message" paragraphs in the built documents.
103 #keep_warnings = False
104
105
106 # -- Options for HTML output ----------------------------------------------
107
108 # The theme to use for HTML and HTML Help pages.  See the documentation for
109 # a list of builtin themes.
110 html_theme = 'default'
111
112 # Theme options are theme-specific and customize the look and feel of a theme
113 # further.  For a list of options available for each theme, see the
114 # documentation.
115 #html_theme_options = {}
116
117 # Add any paths that contain custom themes here, relative to this directory.
118 #html_theme_path = []
119
120 # The name for this set of Sphinx documents.  If None, it defaults to
121 # "<project> v<release> documentation".
122 #html_title = None
123
124 # A shorter title for the navigation bar.  Default is the same as html_title.
125 #html_short_title = None
126
127 # The name of an image file (relative to this directory) to place at the top
128 # of the sidebar.
129 #html_logo = None
130
131 # The name of an image file (within the static path) to use as favicon of the
132 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
133 # pixels large.
134 #html_favicon = None
135
136 # Add any paths that contain custom static files (such as style sheets) here,
137 # relative to this directory. They are copied after the builtin static files,
138 # so a file named "default.css" will overwrite the builtin "default.css".
139 html_static_path = ['_static']
140
141 # Add any extra paths that contain custom files (such as robots.txt or
142 # .htaccess) here, relative to this directory. These files are copied
143 # directly to the root of the documentation.
144 #html_extra_path = []
145
146 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
147 # using the given strftime format.
148 #html_last_updated_fmt = '%b %d, %Y'
149
150 # If true, SmartyPants will be used to convert quotes and dashes to
151 # typographically correct entities.
152 #html_use_smartypants = True
153
154 # Custom sidebar templates, maps document names to template names.
155 #html_sidebars = {}
156
157 # Additional templates that should be rendered to pages, maps page names to
158 # template names.
159 #html_additional_pages = {}
160
161 # If false, no module index is generated.
162 #html_domain_indices = True
163
164 # If false, no index is generated.
165 #html_use_index = True
166
167 # If true, the index is split into individual pages for each letter.
168 #html_split_index = False
169
170 # If true, links to the reST sources are added to the pages.
171 #html_show_sourcelink = True
172
173 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
174 #html_show_sphinx = True
175
176 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
177 #html_show_copyright = True
178
179 # If true, an OpenSearch description file will be output, and all pages will
180 # contain a <link> tag referring to it.  The value of this option must be the
181 # base URL from which the finished HTML is served.
182 #html_use_opensearch = ''
183
184 # This is the file name suffix for HTML files (e.g. ".xhtml").
185 #html_file_suffix = None
186
187 # Output file base name for HTML help builder.
188 htmlhelp_basename = 'mediawiki-utilitiesdoc'
189
190
191 # -- Options for LaTeX output ---------------------------------------------
192
193 latex_elements = {
194 # The paper size ('letterpaper' or 'a4paper').
195 #'papersize': 'letterpaper',
196
197 # The font size ('10pt', '11pt' or '12pt').
198 #'pointsize': '10pt',
199
200 # Additional stuff for the LaTeX preamble.
201 #'preamble': '',
202 }
203
204 # Grouping the document tree into LaTeX files. List of tuples
205 # (source start file, target name, title,
206 #  author, documentclass [howto, manual, or own class]).
207 latex_documents = [
208   ('index', 'mediawiki-utilities.tex', 'mediawiki-utilities Documentation',
209    'Aaron Halfaker', 'manual'),
210 ]
211
212 # The name of an image file (relative to this directory) to place at the top of
213 # the title page.
214 #latex_logo = None
215
216 # For "manual" documents, if this is true, then toplevel headings are parts,
217 # not chapters.
218 #latex_use_parts = False
219
220 # If true, show page references after internal links.
221 #latex_show_pagerefs = False
222
223 # If true, show URL addresses after external links.
224 #latex_show_urls = False
225
226 # Documents to append as an appendix to all manuals.
227 #latex_appendices = []
228
229 # If false, no module index is generated.
230 #latex_domain_indices = True
231
232
233 # -- Options for manual page output ---------------------------------------
234
235 # One entry per manual page. List of tuples
236 # (source start file, name, description, authors, manual section).
237 man_pages = [
238     ('index', 'mediawiki-utilities', 'mediawiki-utilities Documentation',
239      ['Aaron Halfaker'], 1)
240 ]
241
242 # If true, show URL addresses after external links.
243 #man_show_urls = False
244
245
246 # -- Options for Texinfo output -------------------------------------------
247
248 # Grouping the document tree into Texinfo files. List of tuples
249 # (source start file, target name, title, author,
250 #  dir menu entry, description, category)
251 texinfo_documents = [
252   ('index', 'mediawiki-utilities', 'mediawiki-utilities Documentation',
253    'Aaron Halfaker', 'mediawiki-utilities', 'One line description of project.',
254    'Miscellaneous'),
255 ]
256
257 # Documents to append as an appendix to all manuals.
258 #texinfo_appendices = []
259
260 # If false, no module index is generated.
261 #texinfo_domain_indices = True
262
263 # How to display URL addresses: 'footnote', 'no', or 'inline'.
264 #texinfo_show_urls = 'footnote'
265
266 # If true, do not generate a @detailmenu in the "Top" node's menu.
267 #texinfo_no_detailmenu = False

Community Data Science Collective || Want to submit a patch?