Grzegorz Bialas
60388e2da8
This change enchances documentation:
- Adds magnum_capi_helm configuration reference using oslo.config
- Structures labels in table for clarity and adds new ones
- Removing skip_install = True from tox.ini which prevented
documentaton build
Change-Id: I7cc8249270911b0092179076c63722527fa8a65a
Signed-off-by: Grzegorz Bialas <grzegorz@stackhpc.com>
120 lines
3.5 KiB
Python
120 lines
3.5 KiB
Python
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
# implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
import os
|
|
import sys
|
|
|
|
sys.path.insert(0, os.path.abspath("../.."))
|
|
# -- General configuration ----------------------------------------------------
|
|
|
|
# Add any Sphinx extension module names here, as strings. They can be
|
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
|
extensions = [
|
|
"sphinx.ext.autodoc",
|
|
"openstackdocstheme",
|
|
"oslo_config.sphinxext",
|
|
"oslo_config.sphinxconfiggen",
|
|
]
|
|
|
|
# openstackdocstheme options
|
|
openstackdocs_repo_name = "openstack/magnum-capi-helm"
|
|
openstackdocs_pdf_link = True
|
|
openstackdocs_use_storyboard = False
|
|
|
|
# sphinxcontrib.apidoc options
|
|
config_generator_config_file = [
|
|
("../../etc/oslo-config-generator/capi_helm.conf", "_static/capi_helm"),
|
|
]
|
|
|
|
# autodoc generation is a bit aggressive and a nuisance when doing heavy
|
|
# text edit cycles.
|
|
# execute "export SPHINX_DEBUG=1" in your terminal to disable
|
|
|
|
# The suffix of source filenames.
|
|
source_suffix = ".rst"
|
|
|
|
# The master toctree document.
|
|
master_doc = "index"
|
|
|
|
# General information about the project.
|
|
project = "magnum-capi-helm"
|
|
copyright = "2013-present, OpenStack Foundation"
|
|
current_release = "2023.1"
|
|
|
|
# If true, '()' will be appended to :func: etc. cross-reference text.
|
|
add_function_parentheses = True
|
|
|
|
# If true, the current module name will be prepended to all description
|
|
# unit titles (such as .. function::).
|
|
add_module_names = True
|
|
|
|
# The name of the Pygments (syntax highlighting) style to use.
|
|
pygments_style = "native"
|
|
|
|
# -- Options for HTML output --------------------------------------------------
|
|
|
|
# The theme to use for HTML and HTML Help pages. Major themes that come with
|
|
# Sphinx are currently 'default' and 'sphinxdoc'.
|
|
# html_theme_path = ["."]
|
|
html_theme = "openstackdocs"
|
|
# html_static_path = ['static']
|
|
|
|
# Output file base name for HTML help builder.
|
|
htmlhelp_basename = "%sdoc" % project
|
|
|
|
# Grouping the document tree into LaTeX files. List of tuples
|
|
# (source start file, target name, title, author, documentclass
|
|
# [howto/manual]).
|
|
latex_documents = [
|
|
(
|
|
"index",
|
|
"doc-%s.tex" % project,
|
|
"%s Documentation" % project,
|
|
"OpenStack Foundation",
|
|
"manual",
|
|
),
|
|
]
|
|
|
|
# If false, no module index is generated.
|
|
latex_domain_indices = False
|
|
|
|
latex_elements = {
|
|
"makeindex": "",
|
|
"printindex": "",
|
|
"preamble": r"\setcounter{tocdepth}{3}",
|
|
"maxlistdepth": 10,
|
|
}
|
|
|
|
# Disable usage of xindy https://bugzilla.redhat.com/show_bug.cgi?id=1643664
|
|
latex_use_xindy = False
|
|
|
|
# Example configuration for intersphinx: refer to the Python standard library.
|
|
# intersphinx_mapping = {'http://docs.python.org/': None}
|
|
|
|
# openstackdocstheme options
|
|
openstackdocs_repo_name = "openstack/magnum-capi-helm"
|
|
openstackdocs_pdf_link = True
|
|
openstackdocs_bug_project = "magnum"
|
|
openstackdocs_bug_tag = "magnum-capi-helm"
|
|
openstackdocs_auto_name = False
|
|
openstackdocs_projects = [
|
|
"magnum",
|
|
]
|
|
|
|
# Substitutions loader
|
|
rst_prolog = """
|
|
.. |current_release| replace:: {current_release}
|
|
""".format( # noqa: E501
|
|
current_release=current_release,
|
|
)
|