Debian Codegraph @

doc/source/conf.py

raw
1 # Freezer documentation build configuration file, created by
2 # sphinx-quickstart on Thu Feb 4 22:27:35 2016.
3 #
4 # This file is execfile()d with the current directory set to its
5 # 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
14 import os
15
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.insert(0, os.path.abspath('.'))
20
21 # -- General configuration ------------------------------------------------
22
23 # If your documentation needs a minimal Sphinx version, state it here.
24 #needs_sphinx = '1.0'
25
26 # Add any Sphinx extension module names here, as strings. They can be
27 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
28 # ones.
29 extensions = ['sphinx.ext.autodoc',
30 'sphinx.ext.viewcode',
31 'openstackdocstheme']
32
33 # Add any paths that contain templates here, relative to this directory.
34 templates_path = ['_templates']
35
36 # The suffix of source filenames.
37 source_suffix = '.rst'
38
39 # The encoding of source files.
40 #source_encoding = 'utf-8-sig'
41
42 # The master toctree document.
43 master_doc = 'index'
44
45 # General information about the project.
46 copyright = '2016, OpenStack'
47
48 # openstackdocstheme options
49 openstackdocs_repo_name = 'openstack/python-freezerclient'
50 openstackdocs_bug_project = 'freezer'
51 openstackdocs_bug_tag = 'python-freezerclient'
52
53 # The language for content autogenerated by Sphinx. Refer to documentation
54 # for a list of supported languages.
55 #language = None
56
57 # There are two options for replacing |today|: either, you set today to some
58 # non-false value, then it is used:
59 #today = ''
60 # Else, today_fmt is used as the format for a strftime call.
61 #today_fmt = '%B %d, %Y'
62
63 # List of patterns, relative to source directory, that match files and
64 # directories to ignore when looking for source files.
65 exclude_patterns = []
66
67 # The reST default role (used for this markup: `text`) to use for all
68 # documents.
69 #default_role = None
70
71 # If true, '()' will be appended to :func: etc. cross-reference text.
72 #add_function_parentheses = True
73
74 # If true, the current module name will be prepended to all description
75 # unit titles (such as .. function::).
76 #add_module_names = True
77
78 # If true, sectionauthor and moduleauthor directives will be shown in the
79 # output. They are ignored by default.
80 #show_authors = False
81
82 # The name of the Pygments (syntax highlighting) style to use.
83 pygments_style = 'native'
84
85 # A list of ignored prefixes for module index sorting.
86 #modindex_common_prefix = []
87
88 # If true, keep warnings as "system message" paragraphs in the built documents.
89 #keep_warnings = False
90
91
92 # -- Options for HTML output ----------------------------------------------
93
94 # The theme to use for HTML and HTML Help pages. See the documentation for
95 # a list of builtin themes.
96 html_theme = 'openstackdocs'
97
98 # Theme options are theme-specific and customize the look and feel of a theme
99 # further. For a list of options available for each theme, see the
100 # documentation.
101 #html_theme_options = {}
102
103 # Add any paths that contain custom themes here, relative to this directory.
104 #html_theme_path = []
105
106 # The name for this set of Sphinx documents. If None, it defaults to
107 # "<project> v<release> documentation".
108 #html_title = None
109
110 # A shorter title for the navigation bar. Default is the same as html_title.
111 #html_short_title = None
112
113 # The name of an image file (relative to this directory) to place at the top
114 # of the sidebar.
115 #html_logo = None
116
117 # The name of an image file (within the static path) to use as favicon of the
118 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
119 # pixels large.
120 #html_favicon = None
121
122 # Add any paths that contain custom static files (such as style sheets) here,
123 # relative to this directory. They are copied after the builtin static files,
124 # so a file named "default.css" will overwrite the builtin "default.css".
125 # html_static_path = ['_static']
126
127 # Add any extra paths that contain custom files (such as robots.txt or
128 # .htaccess) here, relative to this directory. These files are copied
129 # directly to the root of the documentation.
130 #html_extra_path = []
131
132 # If true, SmartyPants will be used to convert quotes and dashes to
133 # typographically correct entities.
134 #html_use_smartypants = True
135
136 # Custom sidebar templates, maps document names to template names.
137 #html_sidebars = {}
138
139 # Additional templates that should be rendered to pages, maps page names to
140 # template names.
141 #html_additional_pages = {}
142
143 # If false, no module index is generated.
144 #html_domain_indices = True
145
146 # If false, no index is generated.
147 #html_use_index = True
148
149 # If true, the index is split into individual pages for each letter.
150 #html_split_index = False
151
152 # If true, links to the reST sources are added to the pages.
153 #html_show_sourcelink = True
154
155 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
156 #html_show_sphinx = True
157
158 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
159 #html_show_copyright = True
160
161 # If true, an OpenSearch description file will be output, and all pages will
162 # contain a <link> tag referring to it. The value of this option must be the
163 # base URL from which the finished HTML is served.
164 #html_use_opensearch = ''
165
166 # This is the file name suffix for HTML files (e.g. ".xhtml").
167 #html_file_suffix = None
168
169 # Output file base name for HTML help builder.
170 htmlhelp_basename = 'Freezerdoc'
171
172
173 # -- Options for LaTeX output ---------------------------------------------
174
175 latex_elements = {
176 # The paper size ('letterpaper' or 'a4paper').
177 #'papersize': 'letterpaper',
178
179 # The font size ('10pt', '11pt' or '12pt').
180 #'pointsize': '10pt',
181
182 # Additional stuff for the LaTeX preamble.
183 #'preamble': '',
184 }
185
186 # Grouping the document tree into LaTeX files. List of tuples
187 # (source start file, target name, title,
188 # author, documentclass [howto, manual, or own class]).
189 latex_documents = [
190 ('index', 'Freezer.tex', 'Freezer Documentation',
191 'OpenStack', 'manual'),
192 ]
193
194 # The name of an image file (relative to this directory) to place at the top of
195 # the title page.
196 #latex_logo = None
197
198 # For "manual" documents, if this is true, then toplevel headings are parts,
199 # not chapters.
200 #latex_use_parts = False
201
202 # If true, show page references after internal links.
203 #latex_show_pagerefs = False
204
205 # If true, show URL addresses after external links.
206 #latex_show_urls = False
207
208 # Documents to append as an appendix to all manuals.
209 #latex_appendices = []
210
211 # If false, no module index is generated.
212 #latex_domain_indices = True
213
214
215 # -- Options for manual page output ---------------------------------------
216
217 # One entry per manual page. List of tuples
218 # (source start file, name, description, authors, manual section).
219 man_pages = [
220 ('index', 'freezer', 'Freezer Documentation',
221 ['OpenStack'], 1)
222 ]
223
224 # If true, show URL addresses after external links.
225 #man_show_urls = False
226
227
228 # -- Options for Texinfo output -------------------------------------------
229
230 # Grouping the document tree into Texinfo files. List of tuples
231 # (source start file, target name, title, author,
232 # dir menu entry, description, category)
233 texinfo_documents = [
234 ('index', 'Freezer', 'Freezer Documentation',
235 'OpenStack', 'Freezer', 'One line description of project.',
236 'Miscellaneous'),
237 ]
238
239 # Documents to append as an appendix to all manuals.
240 #texinfo_appendices = []
241
242 # If false, no module index is generated.
243 #texinfo_domain_indices = True
244
245 # How to display URL addresses: 'footnote', 'no', or 'inline'.
246 #texinfo_show_urls = 'footnote'
247
248 # If true, do not generate a @detailmenu in the "Top" node's menu.
249 #texinfo_no_detailmenu = False
250
251
252 # Example configuration for intersphinx: refer to the Python standard library.
253 #intersphinx_mapping = {'http://docs.python.org/': None}
254