blob: 7a12515e09dcc3c0f78ae774b7125a5b6b50c4ac [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.
ricoline884f122024-11-01 16:28:13 +080014from __future__ import annotations
okozachenko093ce9e2021-04-01 22:47:39 +030015
16import os
17import sys
18
okozachenko1203fa747f22022-05-16 20:13:54 +100019sys.path.insert(0, os.path.abspath("../.."))
okozachenko093ce9e2021-04-01 22:47:39 +030020# -- 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.
okozachenko1203a2216692022-05-16 22:45:09 +100024extensions = ["sphinx.ext.autodoc", "openstackdocstheme"]
okozachenko093ce9e2021-04-01 22:47:39 +030025
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.
okozachenko1203fa747f22022-05-16 20:13:54 +100031source_suffix = ".rst"
okozachenko093ce9e2021-04-01 22:47:39 +030032
33# The master toctree document.
okozachenko1203fa747f22022-05-16 20:13:54 +100034master_doc = "index"
okozachenko093ce9e2021-04-01 22:47:39 +030035
36# General information about the project.
okozachenko1203fa747f22022-05-16 20:13:54 +100037project = "staffeln"
38copyright = "2017, OpenStack Developers"
okozachenko093ce9e2021-04-01 22:47:39 +030039
40# openstackdocstheme options
okozachenko1203fa747f22022-05-16 20:13:54 +100041openstackdocs_repo_name = "openstack/staffeln"
42openstackdocs_bug_project = (
ricoline884f122024-11-01 16:28:13 +080043 "replace with the name of the project on "
44 "Launchpad or the ID from Storyboard")
okozachenko1203fa747f22022-05-16 20:13:54 +100045openstackdocs_bug_tag = ""
okozachenko093ce9e2021-04-01 22:47:39 +030046
47# If true, '()' will be appended to :func: etc. cross-reference text.
48add_function_parentheses = True
49
50# If true, the current module name will be prepended to all description
51# unit titles (such as .. function::).
52add_module_names = True
53
54# The name of the Pygments (syntax highlighting) style to use.
okozachenko1203fa747f22022-05-16 20:13:54 +100055pygments_style = "native"
okozachenko093ce9e2021-04-01 22:47:39 +030056
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']
okozachenko1203fa747f22022-05-16 20:13:54 +100064html_theme = "openstackdocs"
okozachenko093ce9e2021-04-01 22:47:39 +030065
66# Output file base name for HTML help builder.
okozachenko1203fa747f22022-05-16 20:13:54 +100067htmlhelp_basename = "%sdoc" % project
okozachenko093ce9e2021-04-01 22:47:39 +030068
69# Grouping the document tree into LaTeX files. List of tuples
70# (source start file, target name, title, author, documentclass
71# [howto/manual]).
72latex_documents = [
okozachenko1203fa747f22022-05-16 20:13:54 +100073 (
74 "index",
75 "%s.tex" % project,
76 "%s Documentation" % project,
77 "OpenStack Developers",
78 "manual",
79 ),
okozachenko093ce9e2021-04-01 22:47:39 +030080]
81
82# Example configuration for intersphinx: refer to the Python standard library.
okozachenko1203fa747f22022-05-16 20:13:54 +100083# intersphinx_mapping = {'http://docs.python.org/': None}