blob: 1c590d64e692ac3d65c2957d46582bd933f90c3a [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.
14
15import os
16import sys
17
okozachenko1203fa747f22022-05-16 20:13:54 +100018sys.path.insert(0, os.path.abspath("../.."))
okozachenko093ce9e2021-04-01 22:47:39 +030019# -- General configuration ----------------------------------------------------
20
21# Add any Sphinx extension module names here, as strings. They can be
22# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
okozachenko1203a2216692022-05-16 22:45:09 +100023extensions = ["sphinx.ext.autodoc", "openstackdocstheme"]
okozachenko093ce9e2021-04-01 22:47:39 +030024
25# autodoc generation is a bit aggressive and a nuisance when doing heavy
26# text edit cycles.
27# execute "export SPHINX_DEBUG=1" in your terminal to disable
28
29# The suffix of source filenames.
okozachenko1203fa747f22022-05-16 20:13:54 +100030source_suffix = ".rst"
okozachenko093ce9e2021-04-01 22:47:39 +030031
32# The master toctree document.
okozachenko1203fa747f22022-05-16 20:13:54 +100033master_doc = "index"
okozachenko093ce9e2021-04-01 22:47:39 +030034
35# General information about the project.
okozachenko1203fa747f22022-05-16 20:13:54 +100036project = "staffeln"
37copyright = "2017, OpenStack Developers"
okozachenko093ce9e2021-04-01 22:47:39 +030038
39# openstackdocstheme options
okozachenko1203fa747f22022-05-16 20:13:54 +100040openstackdocs_repo_name = "openstack/staffeln"
41openstackdocs_bug_project = (
42 "replace with the name of the project on Launchpad or the ID from Storyboard"
43)
44openstackdocs_bug_tag = ""
okozachenko093ce9e2021-04-01 22:47:39 +030045
46# If true, '()' will be appended to :func: etc. cross-reference text.
47add_function_parentheses = True
48
49# If true, the current module name will be prepended to all description
50# unit titles (such as .. function::).
51add_module_names = True
52
53# The name of the Pygments (syntax highlighting) style to use.
okozachenko1203fa747f22022-05-16 20:13:54 +100054pygments_style = "native"
okozachenko093ce9e2021-04-01 22:47:39 +030055
56# -- Options for HTML output --------------------------------------------------
57
58# The theme to use for HTML and HTML Help pages. Major themes that come with
59# Sphinx are currently 'default' and 'sphinxdoc'.
60# html_theme_path = ["."]
61# html_theme = '_theme'
62# html_static_path = ['static']
okozachenko1203fa747f22022-05-16 20:13:54 +100063html_theme = "openstackdocs"
okozachenko093ce9e2021-04-01 22:47:39 +030064
65# Output file base name for HTML help builder.
okozachenko1203fa747f22022-05-16 20:13:54 +100066htmlhelp_basename = "%sdoc" % project
okozachenko093ce9e2021-04-01 22:47:39 +030067
68# Grouping the document tree into LaTeX files. List of tuples
69# (source start file, target name, title, author, documentclass
70# [howto/manual]).
71latex_documents = [
okozachenko1203fa747f22022-05-16 20:13:54 +100072 (
73 "index",
74 "%s.tex" % project,
75 "%s Documentation" % project,
76 "OpenStack Developers",
77 "manual",
78 ),
okozachenko093ce9e2021-04-01 22:47:39 +030079]
80
81# Example configuration for intersphinx: refer to the Python standard library.
okozachenko1203fa747f22022-05-16 20:13:54 +100082# intersphinx_mapping = {'http://docs.python.org/': None}