blob: 3588b3d05c1bb9841a378ce02b41f8cd8e2b042c [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.
23extensions = [
okozachenko1203fa747f22022-05-16 20:13:54 +100024 "sphinx.ext.autodoc",
25 "openstackdocstheme",
okozachenko093ce9e2021-04-01 22:47:39 +030026 #'sphinx.ext.intersphinx',
27]
28
29# autodoc generation is a bit aggressive and a nuisance when doing heavy
30# text edit cycles.
31# execute "export SPHINX_DEBUG=1" in your terminal to disable
32
33# The suffix of source filenames.
okozachenko1203fa747f22022-05-16 20:13:54 +100034source_suffix = ".rst"
okozachenko093ce9e2021-04-01 22:47:39 +030035
36# The master toctree document.
okozachenko1203fa747f22022-05-16 20:13:54 +100037master_doc = "index"
okozachenko093ce9e2021-04-01 22:47:39 +030038
39# General information about the project.
okozachenko1203fa747f22022-05-16 20:13:54 +100040project = "staffeln"
41copyright = "2017, OpenStack Developers"
okozachenko093ce9e2021-04-01 22:47:39 +030042
43# openstackdocstheme options
okozachenko1203fa747f22022-05-16 20:13:54 +100044openstackdocs_repo_name = "openstack/staffeln"
45openstackdocs_bug_project = (
46 "replace with the name of the project on Launchpad or the ID from Storyboard"
47)
48openstackdocs_bug_tag = ""
okozachenko093ce9e2021-04-01 22:47:39 +030049
50# If true, '()' will be appended to :func: etc. cross-reference text.
51add_function_parentheses = True
52
53# If true, the current module name will be prepended to all description
54# unit titles (such as .. function::).
55add_module_names = True
56
57# The name of the Pygments (syntax highlighting) style to use.
okozachenko1203fa747f22022-05-16 20:13:54 +100058pygments_style = "native"
okozachenko093ce9e2021-04-01 22:47:39 +030059
60# -- Options for HTML output --------------------------------------------------
61
62# The theme to use for HTML and HTML Help pages. Major themes that come with
63# Sphinx are currently 'default' and 'sphinxdoc'.
64# html_theme_path = ["."]
65# html_theme = '_theme'
66# html_static_path = ['static']
okozachenko1203fa747f22022-05-16 20:13:54 +100067html_theme = "openstackdocs"
okozachenko093ce9e2021-04-01 22:47:39 +030068
69# Output file base name for HTML help builder.
okozachenko1203fa747f22022-05-16 20:13:54 +100070htmlhelp_basename = "%sdoc" % project
okozachenko093ce9e2021-04-01 22:47:39 +030071
72# Grouping the document tree into LaTeX files. List of tuples
73# (source start file, target name, title, author, documentclass
74# [howto/manual]).
75latex_documents = [
okozachenko1203fa747f22022-05-16 20:13:54 +100076 (
77 "index",
78 "%s.tex" % project,
79 "%s Documentation" % project,
80 "OpenStack Developers",
81 "manual",
82 ),
okozachenko093ce9e2021-04-01 22:47:39 +030083]
84
85# Example configuration for intersphinx: refer to the Python standard library.
okozachenko1203fa747f22022-05-16 20:13:54 +100086# intersphinx_mapping = {'http://docs.python.org/': None}