summaryrefslogtreecommitdiff
path: root/doc/source/conf.py
diff options
context:
space:
mode:
Diffstat (limited to 'doc/source/conf.py')
-rw-r--r--doc/source/conf.py276
1 files changed, 276 insertions, 0 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py
new file mode 100644
index 0000000..d8caebe
--- /dev/null
+++ b/doc/source/conf.py
@@ -0,0 +1,276 @@
1# -*- coding: utf-8 -*-
2#
3# Tempest documentation build configuration file, created by
4# sphinx-quickstart on Tue May 21 17:43:32 2013.
5#
6# This file is execfile()d with the current directory set to its containing dir.
7#
8# Note that not all possible configuration values are present in this
9# autogenerated file.
10#
11# All configuration values have a default; values that are commented out
12# serve to show the default.
13
14import datetime
15import subprocess
16import sys
17import 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.
22sys.path.insert(0, os.path.abspath('.'))
23on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
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 extensions
31# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
32extensions = ['redirect',
33 'sphinx.ext.autodoc',
34 'sphinx.ext.todo',
35 'sphinx.ext.viewcode',
36 'yasfb',
37 ]
38
39# Feed configuration for yasfb
40feed_base_url = 'http://glare-specs.readthedocs.org'
41feed_author = 'OpenStack Glare Team'
42
43todo_include_todos = True
44
45# Add any paths that contain templates here, relative to this directory.
46templates_path = ['_templates']
47
48# The suffix of source filenames.
49source_suffix = '.rst'
50
51# The encoding of source files.
52#source_encoding = 'utf-8-sig'
53
54# The master toctree document.
55master_doc = 'index'
56
57# General information about the project.
58project = u'Glare Specs'
59copyright = u'%s, OpenStack Glare Team' % datetime.date.today().year
60
61# The language for content autogenerated by Sphinx. Refer to documentation
62# for a list of supported languages.
63#language = None
64
65# There are two options for replacing |today|: either, you set today to some
66# non-false value, then it is used:
67#today = ''
68# Else, today_fmt is used as the format for a strftime call.
69#today_fmt = '%B %d, %Y'
70
71# List of patterns, relative to source directory, that match files and
72# directories to ignore when looking for source files.
73exclude_patterns = [
74 '_build',
75 '**/template.rst',
76]
77
78# The reST default role (used for this markup: `text`) to use for all documents.
79#default_role = None
80
81# If true, '()' will be appended to :func: etc. cross-reference text.
82#add_function_parentheses = True
83
84# If true, the current module name will be prepended to all description
85# unit titles (such as .. function::).
86add_module_names = False
87
88# If true, sectionauthor and moduleauthor directives will be shown in the
89# output. They are ignored by default.
90show_authors = False
91
92# The name of the Pygments (syntax highlighting) style to use.
93pygments_style = 'sphinx'
94
95# A list of ignored prefixes for module index sorting.
96modindex_common_prefix = ['glare-specs.']
97
98# -- Options for man page output ----------------------------------------------
99man_pages = []
100
101# -- Options for HTML output ---------------------------------------------------
102
103# Theme options are theme-specific and customize the look and feel of a theme
104# further. For a list of options available for each theme, see the
105# documentation.
106#html_theme_options = {}
107
108# Add any paths that contain custom themes here, relative to this directory.
109#html_theme_path = []
110
111# The name for this set of Sphinx documents. If None, it defaults to
112# "<project> v<release> documentation".
113#html_title = None
114
115# A shorter title for the navigation bar. Default is the same as html_title.
116#html_short_title = None
117
118# The name of an image file (relative to this directory) to place at the top
119# of the sidebar.
120#html_logo = None
121
122# The name of an image file (within the static path) to use as favicon of the
123# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
124# pixels large.
125#html_favicon = None
126
127# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
128# using the given strftime format.
129git_cmd = ["git", "log", "--pretty=format:'%ad, commit %h'", "--date=local",
130 "-n1"]
131html_last_updated_fmt = subprocess.Popen(
132 git_cmd, stdout=subprocess.PIPE).communicate()[0]
133
134# If true, SmartyPants will be used to convert quotes and dashes to
135# typographically correct entities.
136#html_use_smartypants = True
137
138# Custom sidebar templates, maps document names to template names.
139#html_sidebars = {}
140
141# Additional templates that should be rendered to pages, maps page names to
142# template names.
143#html_additional_pages = {}
144
145# If false, no module index is generated.
146html_domain_indices = False
147
148# If false, no index is generated.
149html_use_index = False
150
151# If true, the index is split into individual pages for each letter.
152#html_split_index = False
153
154# If true, links to the reST sources are added to the pages.
155#html_show_sourcelink = True
156
157# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
158#html_show_sphinx = True
159
160# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
161#html_show_copyright = True
162
163# If true, an OpenSearch description file will be output, and all pages will
164# contain a <link> tag referring to it. The value of this option must be the
165# base URL from which the finished HTML is served.
166#html_use_opensearch = ''
167
168# This is the file name suffix for HTML files (e.g. ".xhtml").
169#html_file_suffix = None
170
171# Output file base name for HTML help builder.
172htmlhelp_basename = 'Glare-Specsdoc'
173
174
175# -- Options for LaTeX output --------------------------------------------------
176
177latex_elements = {
178# The paper size ('letterpaper' or 'a4paper').
179#'papersize': 'letterpaper',
180
181# The font size ('10pt', '11pt' or '12pt').
182#'pointsize': '10pt',
183
184# Additional stuff for the LaTeX preamble.
185#'preamble': '',
186}
187
188# Grouping the document tree into LaTeX files. List of tuples
189# (source start file, target name, title, author, documentclass [howto/manual]).
190latex_documents = [
191 ('index', 'Glare-specs.tex', u'Glare Specs',
192 u'OpenStack Glare Team', 'manual'),
193]
194
195# The name of an image file (relative to this directory) to place at the top of
196# the title page.
197#latex_logo = None
198
199# For "manual" documents, if this is true, then toplevel headings are parts,
200# not chapters.
201#latex_use_parts = False
202
203# If true, show page references after internal links.
204#latex_show_pagerefs = False
205
206# If true, show URL addresses after external links.
207#latex_show_urls = False
208
209# Documents to append as an appendix to all manuals.
210#latex_appendices = []
211
212# If false, no module index is generated.
213#latex_domain_indices = True
214
215# -- Options for Texinfo output ------------------------------------------------
216
217# Grouping the document tree into Texinfo files. List of tuples
218# (source start file, target name, title, author,
219# dir menu entry, description, category)
220texinfo_documents = [
221 ('index', 'Glare-specs', u'Glare Design Specs',
222 u'OpenStack Glare Team', 'glare-specs', 'Design specifications for the Glare project.',
223 'Miscellaneous'),
224]
225
226# Documents to append as an appendix to all manuals.
227#texinfo_appendices = []
228
229# If false, no module index is generated.
230#texinfo_domain_indices = True
231
232# How to display URL addresses: 'footnote', 'no', or 'inline'.
233#texinfo_show_urls = 'footnote'
234
235
236# -- Options for Epub output ---------------------------------------------------
237
238# Bibliographic Dublin Core info.
239epub_title = u'Glare Specs'
240epub_author = u'OpenStack Glare Team'
241epub_publisher = u'OpenStack Glare Team'
242epub_copyright = u'2014, OpenStack Glare Team'
243
244# The language of the text. It defaults to the language option
245# or en if the language is not set.
246#epub_language = ''
247
248# The scheme of the identifier. Typical schemes are ISBN or URL.
249#epub_scheme = ''
250
251# The unique identifier of the text. This can be a ISBN number
252# or the project homepage.
253#epub_identifier = ''
254
255# A unique identification for the text.
256#epub_uid = ''
257
258# A tuple containing the cover image and cover page html template filenames.
259#epub_cover = ()
260
261# HTML files that should be inserted before the pages created by sphinx.
262# The format is a list of tuples containing the path and title.
263#epub_pre_files = []
264
265# HTML files shat should be inserted after the pages created by sphinx.
266# The format is a list of tuples containing the path and title.
267#epub_post_files = []
268
269# A list of files that should not be packed into the epub file.
270#epub_exclude_files = []
271
272# The depth of the table of contents in toc.ncx.
273#epub_tocdepth = 3
274
275# Allow duplicate toc entries.
276#epub_tocdup = True