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. |
ricolin | e884f12 | 2024-11-01 16:28:13 +0800 | [diff] [blame] | 14 | from __future__ import annotations |
okozachenko | 093ce9e | 2021-04-01 22:47:39 +0300 | [diff] [blame] | 15 | |
| 16 | import os |
| 17 | import sys |
| 18 | |
okozachenko1203 | fa747f2 | 2022-05-16 20:13:54 +1000 | [diff] [blame] | 19 | sys.path.insert(0, os.path.abspath("../..")) |
okozachenko | 093ce9e | 2021-04-01 22:47:39 +0300 | [diff] [blame] | 20 | # -- General configuration ---------------------------------------------------- |
| 21 | |
| 22 | # Add any Sphinx extension module names here, as strings. They can be |
| 23 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. |
okozachenko1203 | a221669 | 2022-05-16 22:45:09 +1000 | [diff] [blame] | 24 | extensions = ["sphinx.ext.autodoc", "openstackdocstheme"] |
okozachenko | 093ce9e | 2021-04-01 22:47:39 +0300 | [diff] [blame] | 25 | |
| 26 | # autodoc generation is a bit aggressive and a nuisance when doing heavy |
| 27 | # text edit cycles. |
| 28 | # execute "export SPHINX_DEBUG=1" in your terminal to disable |
| 29 | |
| 30 | # The suffix of source filenames. |
okozachenko1203 | fa747f2 | 2022-05-16 20:13:54 +1000 | [diff] [blame] | 31 | source_suffix = ".rst" |
okozachenko | 093ce9e | 2021-04-01 22:47:39 +0300 | [diff] [blame] | 32 | |
| 33 | # The master toctree document. |
okozachenko1203 | fa747f2 | 2022-05-16 20:13:54 +1000 | [diff] [blame] | 34 | master_doc = "index" |
okozachenko | 093ce9e | 2021-04-01 22:47:39 +0300 | [diff] [blame] | 35 | |
| 36 | # General information about the project. |
okozachenko1203 | fa747f2 | 2022-05-16 20:13:54 +1000 | [diff] [blame] | 37 | project = "staffeln" |
| 38 | copyright = "2017, OpenStack Developers" |
okozachenko | 093ce9e | 2021-04-01 22:47:39 +0300 | [diff] [blame] | 39 | |
| 40 | # openstackdocstheme options |
okozachenko1203 | fa747f2 | 2022-05-16 20:13:54 +1000 | [diff] [blame] | 41 | openstackdocs_repo_name = "openstack/staffeln" |
| 42 | openstackdocs_bug_project = ( |
ricolin | 916cf01 | 2024-12-05 10:30:16 +0800 | [diff] [blame] | 43 | "replace with the name of the project on " "Launchpad or the ID from Storyboard" |
| 44 | ) |
okozachenko1203 | fa747f2 | 2022-05-16 20:13:54 +1000 | [diff] [blame] | 45 | openstackdocs_bug_tag = "" |
okozachenko | 093ce9e | 2021-04-01 22:47:39 +0300 | [diff] [blame] | 46 | |
| 47 | # If true, '()' will be appended to :func: etc. cross-reference text. |
| 48 | add_function_parentheses = True |
| 49 | |
| 50 | # If true, the current module name will be prepended to all description |
| 51 | # unit titles (such as .. function::). |
| 52 | add_module_names = True |
| 53 | |
| 54 | # The name of the Pygments (syntax highlighting) style to use. |
okozachenko1203 | fa747f2 | 2022-05-16 20:13:54 +1000 | [diff] [blame] | 55 | pygments_style = "native" |
okozachenko | 093ce9e | 2021-04-01 22:47:39 +0300 | [diff] [blame] | 56 | |
| 57 | # -- Options for HTML output -------------------------------------------------- |
| 58 | |
| 59 | # The theme to use for HTML and HTML Help pages. Major themes that come with |
| 60 | # Sphinx are currently 'default' and 'sphinxdoc'. |
| 61 | # html_theme_path = ["."] |
| 62 | # html_theme = '_theme' |
| 63 | # html_static_path = ['static'] |
okozachenko1203 | fa747f2 | 2022-05-16 20:13:54 +1000 | [diff] [blame] | 64 | html_theme = "openstackdocs" |
okozachenko | 093ce9e | 2021-04-01 22:47:39 +0300 | [diff] [blame] | 65 | |
| 66 | # Output file base name for HTML help builder. |
okozachenko1203 | fa747f2 | 2022-05-16 20:13:54 +1000 | [diff] [blame] | 67 | htmlhelp_basename = "%sdoc" % project |
okozachenko | 093ce9e | 2021-04-01 22:47:39 +0300 | [diff] [blame] | 68 | |
| 69 | # Grouping the document tree into LaTeX files. List of tuples |
| 70 | # (source start file, target name, title, author, documentclass |
| 71 | # [howto/manual]). |
| 72 | latex_documents = [ |
okozachenko1203 | fa747f2 | 2022-05-16 20:13:54 +1000 | [diff] [blame] | 73 | ( |
| 74 | "index", |
| 75 | "%s.tex" % project, |
| 76 | "%s Documentation" % project, |
| 77 | "OpenStack Developers", |
| 78 | "manual", |
| 79 | ), |
okozachenko | 093ce9e | 2021-04-01 22:47:39 +0300 | [diff] [blame] | 80 | ] |
| 81 | |
| 82 | # Example configuration for intersphinx: refer to the Python standard library. |
okozachenko1203 | fa747f2 | 2022-05-16 20:13:54 +1000 | [diff] [blame] | 83 | # intersphinx_mapping = {'http://docs.python.org/': None} |