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