blob: d4b373ed01ce7c0e7646421ab255fb2572025697 [file] [log] [blame]
okozachenko093ce9e2021-04-01 22:47:39 +03001# -*- coding: utf-8 -*-
2# Licensed under the Apache License, Version 2.0 (the "License");
3# you may not use this file except in compliance with the License.
4# You may obtain a copy of the License at
5#
6# http://www.apache.org/licenses/LICENSE-2.0
7#
8# Unless required by applicable law or agreed to in writing, software
9# distributed under the License is distributed on an "AS IS" BASIS,
10# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
11# implied.
12# See the License for the specific language governing permissions and
13# limitations under the License.
okozachenko093ce9e2021-04-01 22:47:39 +030014# This file is execfile()d with the current directory set to its
15# containing dir.
16#
17# Note that not all possible configuration values are present in this
18# autogenerated file.
19#
20# All configuration values have a default; values that are commented out
21# serve to show the default.
okozachenko093ce9e2021-04-01 22:47:39 +030022# If extensions (or modules to document with autodoc) are in another directory,
23# add these directories to sys.path here. If the directory is relative to the
24# documentation root, use os.path.abspath to make it absolute, like shown here.
25# sys.path.insert(0, os.path.abspath('.'))
okozachenko093ce9e2021-04-01 22:47:39 +030026# -- General configuration ------------------------------------------------
okozachenko093ce9e2021-04-01 22:47:39 +030027# If your documentation needs a minimal Sphinx version, state it here.
28# needs_sphinx = '1.0'
okozachenko093ce9e2021-04-01 22:47:39 +030029# Add any Sphinx extension module names here, as strings. They can be
30# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
31# ones.
ricoline884f122024-11-01 16:28:13 +080032from __future__ import annotations
33
okozachenko093ce9e2021-04-01 22:47:39 +030034extensions = [
okozachenko1203fa747f22022-05-16 20:13:54 +100035 "openstackdocstheme",
36 "reno.sphinxext",
okozachenko093ce9e2021-04-01 22:47:39 +030037]
38
39# Add any paths that contain templates here, relative to this directory.
okozachenko1203fa747f22022-05-16 20:13:54 +100040templates_path = ["_templates"]
okozachenko093ce9e2021-04-01 22:47:39 +030041
42# The suffix of source filenames.
okozachenko1203fa747f22022-05-16 20:13:54 +100043source_suffix = ".rst"
okozachenko093ce9e2021-04-01 22:47:39 +030044
45# The encoding of source files.
46# source_encoding = 'utf-8-sig'
47
48# The master toctree document.
okozachenko1203fa747f22022-05-16 20:13:54 +100049master_doc = "index"
okozachenko093ce9e2021-04-01 22:47:39 +030050
51# General information about the project.
okozachenko1203fa747f22022-05-16 20:13:54 +100052project = "staffeln Release Notes"
53copyright = "2017, OpenStack Developers"
okozachenko093ce9e2021-04-01 22:47:39 +030054
55# openstackdocstheme options
okozachenko1203fa747f22022-05-16 20:13:54 +100056openstackdocs_repo_name = "openstack/staffeln"
okozachenkoaf073202021-04-06 16:56:51 +030057openstackdocs_bug_project = """replace with the name of the
58project on Launchpad or the ID from Storyboard"""
okozachenko1203fa747f22022-05-16 20:13:54 +100059openstackdocs_bug_tag = ""
60openstackdocs_auto_name = "False"
okozachenko093ce9e2021-04-01 22:47:39 +030061
62# The version info for the project you're documenting, acts as replacement for
63# |version| and |release|, also used in various other places throughout the
64# built documents.
65#
66# The short X.Y version.
67# The full version, including alpha/beta/rc tags.
okozachenko1203fa747f22022-05-16 20:13:54 +100068release = ""
okozachenko093ce9e2021-04-01 22:47:39 +030069# The short X.Y version.
okozachenko1203fa747f22022-05-16 20:13:54 +100070version = ""
okozachenko093ce9e2021-04-01 22:47:39 +030071
72# The language for content autogenerated by Sphinx. Refer to documentation
73# for a list of supported languages.
74# language = None
75
76# There are two options for replacing |today|: either, you set today to some
77# non-false value, then it is used:
78# today = ''
79# Else, today_fmt is used as the format for a strftime call.
80# today_fmt = '%B %d, %Y'
81
82# List of patterns, relative to source directory, that match files and
83# directories to ignore when looking for source files.
84exclude_patterns = []
85
86# The reST default role (used for this markup: `text`) to use for all
87# documents.
88# default_role = None
89
90# If true, '()' will be appended to :func: etc. cross-reference text.
91# add_function_parentheses = True
92
93# If true, the current module name will be prepended to all description
94# unit titles (such as .. function::).
95# add_module_names = True
96
97# If true, sectionauthor and moduleauthor directives will be shown in the
98# output. They are ignored by default.
99# show_authors = False
100
101# The name of the Pygments (syntax highlighting) style to use.
okozachenko1203fa747f22022-05-16 20:13:54 +1000102pygments_style = "native"
okozachenko093ce9e2021-04-01 22:47:39 +0300103
104# A list of ignored prefixes for module index sorting.
105# modindex_common_prefix = []
106
107# If true, keep warnings as "system message" paragraphs in the built documents.
108# keep_warnings = False
109
110
111# -- Options for HTML output ----------------------------------------------
112
113# The theme to use for HTML and HTML Help pages. See the documentation for
114# a list of builtin themes.
okozachenko1203fa747f22022-05-16 20:13:54 +1000115html_theme = "openstackdocs"
okozachenko093ce9e2021-04-01 22:47:39 +0300116
117# Theme options are theme-specific and customize the look and feel of a theme
118# further. For a list of options available for each theme, see the
119# documentation.
120# html_theme_options = {}
121
122# Add any paths that contain custom themes here, relative to this directory.
123# html_theme_path = []
124
125# The name for this set of Sphinx documents. If None, it defaults to
126# "<project> v<release> documentation".
127# html_title = None
128
129# A shorter title for the navigation bar. Default is the same as html_title.
130# html_short_title = None
131
132# The name of an image file (relative to this directory) to place at the top
133# of the sidebar.
134# html_logo = None
135
136# The name of an image file (within the static path) to use as favicon of the
137# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
138# pixels large.
139# html_favicon = None
140
141# Add any paths that contain custom static files (such as style sheets) here,
142# relative to this directory. They are copied after the builtin static files,
143# so a file named "default.css" will overwrite the builtin "default.css".
okozachenko1203fa747f22022-05-16 20:13:54 +1000144html_static_path = ["_static"]
okozachenko093ce9e2021-04-01 22:47:39 +0300145
146# Add any extra paths that contain custom files (such as robots.txt or
147# .htaccess) here, relative to this directory. These files are copied
148# directly to the root of the documentation.
149# html_extra_path = []
150
151# If true, SmartyPants will be used to convert quotes and dashes to
152# typographically correct entities.
153# html_use_smartypants = True
154
155# Custom sidebar templates, maps document names to template names.
156# html_sidebars = {}
157
158# Additional templates that should be rendered to pages, maps page names to
159# template names.
160# html_additional_pages = {}
161
162# If false, no module index is generated.
163# html_domain_indices = True
164
165# If false, no index is generated.
166# html_use_index = True
167
168# If true, the index is split into individual pages for each letter.
169# html_split_index = False
170
171# If true, links to the reST sources are added to the pages.
172# html_show_sourcelink = True
173
174# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
175# html_show_sphinx = True
176
177# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
178# html_show_copyright = True
179
180# If true, an OpenSearch description file will be output, and all pages will
181# contain a <link> tag referring to it. The value of this option must be the
182# base URL from which the finished HTML is served.
183# html_use_opensearch = ''
184
185# This is the file name suffix for HTML files (e.g. ".xhtml").
186# html_file_suffix = None
187
188# Output file base name for HTML help builder.
okozachenko1203fa747f22022-05-16 20:13:54 +1000189htmlhelp_basename = "staffelnReleaseNotesdoc"
okozachenko093ce9e2021-04-01 22:47:39 +0300190
191
192# -- Options for LaTeX output ---------------------------------------------
193
194latex_elements = {
195 # The paper size ('letterpaper' or 'a4paper').
196 # 'papersize': 'letterpaper',
okozachenko093ce9e2021-04-01 22:47:39 +0300197 # The font size ('10pt', '11pt' or '12pt').
198 # 'pointsize': '10pt',
okozachenko093ce9e2021-04-01 22:47:39 +0300199 # Additional stuff for the LaTeX preamble.
200 # 'preamble': '',
201}
202
203# Grouping the document tree into LaTeX files. List of tuples
204# (source start file, target name, title,
205# author, documentclass [howto, manual, or own class]).
206latex_documents = [
okozachenko1203fa747f22022-05-16 20:13:54 +1000207 (
208 "index",
209 "staffelnReleaseNotes.tex",
210 "staffeln Release Notes Documentation",
211 "OpenStack Foundation",
212 "manual",
213 ),
okozachenko093ce9e2021-04-01 22:47:39 +0300214]
215
216# The name of an image file (relative to this directory) to place at the top of
217# the title page.
218# latex_logo = None
219
220# For "manual" documents, if this is true, then toplevel headings are parts,
221# not chapters.
222# latex_use_parts = False
223
224# If true, show page references after internal links.
225# latex_show_pagerefs = False
226
227# If true, show URL addresses after external links.
228# latex_show_urls = False
229
230# Documents to append as an appendix to all manuals.
231# latex_appendices = []
232
233# If false, no module index is generated.
234# latex_domain_indices = True
235
236
237# -- Options for manual page output ---------------------------------------
238
239# One entry per manual page. List of tuples
240# (source start file, name, description, authors, manual section).
241man_pages = [
okozachenko1203fa747f22022-05-16 20:13:54 +1000242 (
243 "index",
244 "staffelnrereleasenotes",
245 "staffeln Release Notes Documentation",
246 ["OpenStack Foundation"],
247 1,
248 )
okozachenko093ce9e2021-04-01 22:47:39 +0300249]
250
251# If true, show URL addresses after external links.
252# man_show_urls = False
253
254
255# -- Options for Texinfo output -------------------------------------------
256
257# Grouping the document tree into Texinfo files. List of tuples
258# (source start file, target name, title, author,
259# dir menu entry, description, category)
260texinfo_documents = [
okozachenko1203fa747f22022-05-16 20:13:54 +1000261 (
262 "index",
263 "staffeln ReleaseNotes",
264 "staffeln Release Notes Documentation",
265 "OpenStack Foundation",
266 "staffelnReleaseNotes",
267 "One line description of project.",
268 "Miscellaneous",
269 ),
okozachenko093ce9e2021-04-01 22:47:39 +0300270]
271
272# Documents to append as an appendix to all manuals.
273# texinfo_appendices = []
274
275# If false, no module index is generated.
276# texinfo_domain_indices = True
277
278# How to display URL addresses: 'footnote', 'no', or 'inline'.
279# texinfo_show_urls = 'footnote'
280
281# If true, do not generate a @detailmenu in the "Top" node's menu.
282# texinfo_no_detailmenu = False
283
284# -- Options for Internationalization output ------------------------------
okozachenko1203fa747f22022-05-16 20:13:54 +1000285locale_dirs = ["locale/"]