1
# -*- coding: utf-8 -*-
3
# nova documentation build configuration file, created by
4
# sphinx-quickstart on Sat May 1 15:17:47 2010.
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
# If extensions (or modules to document with autodoc) are in another directory,
17
# add these directories to sys.path here. If the directory is relative to the
18
# documentation root, use os.path.abspath to make it absolute, like shown here.
19
#sys.path.append(os.path.abspath('.'))
20
sys.path.append([os.path.abspath('../nova'),os.path.abspath('../'),os.path.abspath('../vendor')])
21
from nova import vendor
23
# -- General configuration -----------------------------------------------------
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 = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.pngmath', 'sphinx.ext.ifconfig']
28
#sphinx_to_github = False
29
todo_include_todos = True
31
# Add any paths that contain templates here, relative to this directory.
32
templates_path = ['_templates']
34
# The suffix of source filenames.
35
source_suffix = '.rst'
37
# The encoding of source files.
38
#source_encoding = 'utf-8'
40
# The master toctree document.
43
# General information about the project.
45
copyright = u'2010, Anso Labs, LLC'
47
# The version info for the project you're documenting, acts as replacement for
48
# |version| and |release|, also used in various other places throughout the
51
# The short X.Y version.
53
# The full version, including alpha/beta/rc tags.
56
# The language for content autogenerated by Sphinx. Refer to documentation
57
# for a list of supported languages.
60
# There are two options for replacing |today|: either, you set today to some
61
# non-false value, then it is used:
63
# Else, today_fmt is used as the format for a strftime call.
64
#today_fmt = '%B %d, %Y'
66
# List of documents that shouldn't be included in the build.
69
# List of directories, relative to source directory, that shouldn't be searched
71
exclude_trees = ['_build']
73
# The reST default role (used for this markup: `text`) to use for all documents.
76
# If true, '()' will be appended to :func: etc. cross-reference text.
77
#add_function_parentheses = True
79
# If true, the current module name will be prepended to all description
80
# unit titles (such as .. function::).
81
#add_module_names = True
83
# If true, sectionauthor and moduleauthor directives will be shown in the
84
# output. They are ignored by default.
87
# The name of the Pygments (syntax highlighting) style to use.
88
pygments_style = 'sphinx'
90
# A list of ignored prefixes for module index sorting.
91
modindex_common_prefix = ['nova.']
94
# -- Options for HTML output ---------------------------------------------------
96
# The theme to use for HTML and HTML Help pages. Major themes that come with
97
# Sphinx are currently 'default' and 'sphinxdoc'.
98
html_theme = 'default'
100
# Theme options are theme-specific and customize the look and feel of a theme
101
# further. For a list of options available for each theme, see the
103
#html_theme_options = {}
105
# Add any paths that contain custom themes here, relative to this directory.
106
#html_theme_path = []
108
# The name for this set of Sphinx documents. If None, it defaults to
109
# "<project> v<release> documentation".
112
# A shorter title for the navigation bar. Default is the same as html_title.
113
#html_short_title = None
115
# The name of an image file (relative to this directory) to place at the top
119
# The name of an image file (within the static path) to use as favicon of the
120
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
124
# Add any paths that contain custom static files (such as style sheets) here,
125
# relative to this directory. They are copied after the builtin static files,
126
# so a file named "default.css" will overwrite the builtin "default.css".
127
html_static_path = ['_static']
129
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
130
# using the given strftime format.
131
#html_last_updated_fmt = '%b %d, %Y'
133
# If true, SmartyPants will be used to convert quotes and dashes to
134
# typographically correct entities.
135
#html_use_smartypants = True
137
# Custom sidebar templates, maps document names to template names.
140
# Additional templates that should be rendered to pages, maps page names to
142
#html_additional_pages = {}
144
# If false, no module index is generated.
145
#html_use_modindex = True
147
# If false, no index is generated.
148
#html_use_index = True
150
# If true, the index is split into individual pages for each letter.
151
#html_split_index = False
153
# If true, links to the reST sources are added to the pages.
154
#html_show_sourcelink = True
156
# If true, an OpenSearch description file will be output, and all pages will
157
# contain a <link> tag referring to it. The value of this option must be the
158
# base URL from which the finished HTML is served.
159
#html_use_opensearch = ''
161
# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
162
#html_file_suffix = ''
164
# Output file base name for HTML help builder.
165
htmlhelp_basename = 'novadoc'
168
# -- Options for LaTeX output --------------------------------------------------
170
# The paper size ('letter' or 'a4').
171
#latex_paper_size = 'letter'
173
# The font size ('10pt', '11pt' or '12pt').
174
#latex_font_size = '10pt'
176
# Grouping the document tree into LaTeX files. List of tuples
177
# (source start file, target name, title, author, documentclass [howto/manual]).
179
('index', 'nova.tex', u'nova Documentation',
180
u'Anso Labs, LLC', 'manual'),
183
# The name of an image file (relative to this directory) to place at the top of
187
# For "manual" documents, if this is true, then toplevel headings are parts,
189
#latex_use_parts = False
191
# Additional stuff for the LaTeX preamble.
194
# Documents to append as an appendix to all manuals.
195
#latex_appendices = []
197
# If false, no module index is generated.
198
#latex_use_modindex = True
201
# Example configuration for intersphinx: refer to the Python standard library.
202
intersphinx_mapping = {'http://docs.python.org/': None}