1
# -*- coding: utf-8 -*-
3
# curtin documentation build configuration file, created by
4
# sphinx-quickstart on Thu May 30 16:03:34 2013.
6
# This file is execfile()d with the current directory set to its containing dir.
8
# Note that not all possible configuration values are present in this
11
# All configuration values have a default; values that are commented out
12
# serve to show the default.
16
# Fix path so we can import curtin.__version__
17
sys.path.insert(1, os.path.realpath(os.path.join(
18
os.path.dirname(__file__), '..')))
21
# If extensions (or modules to document with autodoc) are in another directory,
22
# add these directories to sys.path here. If the directory is relative to the
23
# documentation root, use os.path.abspath to make it absolute, like shown here.
24
#sys.path.insert(0, os.path.abspath('.'))
26
# -- General configuration -----------------------------------------------------
28
# If your documentation needs a minimal Sphinx version, state it here.
31
# Add any Sphinx extension module names here, as strings. They can be extensions
32
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
35
# Add any paths that contain templates here, relative to this directory.
36
templates_path = ['templates']
38
# The suffix of source filenames.
39
source_suffix = '.rst'
41
# The encoding of source files.
42
#source_encoding = 'utf-8-sig'
44
# The master toctree document.
47
# General information about the project.
49
copyright = u'2016, Scott Moser, Ryan Harper'
51
# The version info for the project you're documenting, acts as replacement for
52
# |version| and |release|, also used in various other places throughout the
55
# The short X.Y version.
56
version = curtin.__version__
57
# The full version, including alpha/beta/rc tags.
60
# The language for content autogenerated by Sphinx. Refer to documentation
61
# for a list of supported languages.
64
# There are two options for replacing |today|: either, you set today to some
65
# non-false value, then it is used:
67
# Else, today_fmt is used as the format for a strftime call.
68
#today_fmt = '%B %d, %Y'
70
# List of patterns, relative to source directory, that match files and
71
# directories to ignore when looking for source files.
72
exclude_patterns = ['_build']
74
# The reST default role (used for this markup: `text`) to use for all documents.
77
# If true, '()' will be appended to :func: etc. cross-reference text.
78
#add_function_parentheses = True
80
# If true, the current module name will be prepended to all description
81
# unit titles (such as .. function::).
82
#add_module_names = True
84
# If true, sectionauthor and moduleauthor directives will be shown in the
85
# output. They are ignored by default.
88
# The name of the Pygments (syntax highlighting) style to use.
89
pygments_style = 'sphinx'
91
# A list of ignored prefixes for module index sorting.
92
#modindex_common_prefix = []
95
# -- Options for HTML output ---------------------------------------------------
97
# The theme to use for HTML and HTML Help pages. See the documentation for
98
# a list of builtin themes.
99
html_theme = 'classic'
101
# on_rtd is whether we are on readthedocs.org, this line of code grabbed from
102
# docs.readthedocs.org
103
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
105
if not on_rtd: # only import and set the theme if we're building docs locally
106
import sphinx_rtd_theme
107
html_theme = 'sphinx_rtd_theme'
108
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
110
# otherwise, readthedocs.org uses their theme by default, so no need to specify
113
# Theme options are theme-specific and customize the look and feel of a theme
114
# further. For a list of options available for each theme, see the
116
#html_theme_options = {}
118
# Add any paths that contain custom themes here, relative to this directory.
119
#html_theme_path = []
121
# The name for this set of Sphinx documents. If None, it defaults to
122
# "<project> v<release> documentation".
125
# A shorter title for the navigation bar. Default is the same as html_title.
126
#html_short_title = None
128
# The name of an image file (relative to this directory) to place at the top
132
# The name of an image file (within the static path) to use as favicon of the
133
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
137
# Add any paths that contain custom static files (such as style sheets) here,
138
# relative to this directory. They are copied after the builtin static files,
139
# so a file named "default.css" will overwrite the builtin "default.css".
140
#html_static_path = ['static']
142
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
143
# using the given strftime format.
144
#html_last_updated_fmt = '%b %d, %Y'
146
# If true, SmartyPants will be used to convert quotes and dashes to
147
# typographically correct entities.
148
#html_use_smartypants = True
150
# Custom sidebar templates, maps document names to template names.
153
# Additional templates that should be rendered to pages, maps page names to
155
#html_additional_pages = {}
157
# If false, no module index is generated.
158
#html_domain_indices = True
160
# If false, no index is generated.
161
#html_use_index = True
163
# If true, the index is split into individual pages for each letter.
164
#html_split_index = False
166
# If true, links to the reST sources are added to the pages.
167
#html_show_sourcelink = True
169
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
170
#html_show_sphinx = True
172
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
173
#html_show_copyright = True
175
# If true, an OpenSearch description file will be output, and all pages will
176
# contain a <link> tag referring to it. The value of this option must be the
177
# base URL from which the finished HTML is served.
178
#html_use_opensearch = ''
180
# This is the file name suffix for HTML files (e.g. ".xhtml").
181
#html_file_suffix = None
183
# Output file base name for HTML help builder.
184
htmlhelp_basename = 'curtindoc'
187
# -- Options for LaTeX output --------------------------------------------------
190
# The paper size ('letterpaper' or 'a4paper').
191
#'papersize': 'letterpaper',
193
# The font size ('10pt', '11pt' or '12pt').
194
#'pointsize': '10pt',
196
# Additional stuff for the LaTeX preamble.
200
# Grouping the document tree into LaTeX files. List of tuples
201
# (source start file, target name, title, author, documentclass [howto/manual]).
203
('index', 'curtin.tex', u'curtin Documentation',
204
u'Scott Moser', 'manual'),
207
# The name of an image file (relative to this directory) to place at the top of
211
# For "manual" documents, if this is true, then toplevel headings are parts,
213
#latex_use_parts = False
215
# If true, show page references after internal links.
216
#latex_show_pagerefs = False
218
# If true, show URL addresses after external links.
219
#latex_show_urls = False
221
# Documents to append as an appendix to all manuals.
222
#latex_appendices = []
224
# If false, no module index is generated.
225
#latex_domain_indices = True
228
# -- Options for manual page output --------------------------------------------
230
# One entry per manual page. List of tuples
231
# (source start file, name, description, authors, manual section).
233
('index', 'curtin', u'curtin Documentation',
237
# If true, show URL addresses after external links.
238
#man_show_urls = False
241
# -- Options for Texinfo output ------------------------------------------------
243
# Grouping the document tree into Texinfo files. List of tuples
244
# (source start file, target name, title, author,
245
# dir menu entry, description, category)
246
texinfo_documents = [
247
('index', 'curtin', u'curtin Documentation',
248
u'Scott Moser', 'curtin', 'One line description of project.',
252
# Documents to append as an appendix to all manuals.
253
#texinfo_appendices = []
255
# If false, no module index is generated.
256
#texinfo_domain_indices = True
258
# How to display URL addresses: 'footnote', 'no', or 'inline'.
259
#texinfo_show_urls = 'footnote'
added
removed
doc/conf.py
