2018-09-24 12:16:02 -05:00
|
|
|
#
|
|
|
|
# SPDX-License-Identifier: Apache-2.0
|
|
|
|
|
|
|
|
# stx-fault API reference documentation build configuration file
|
|
|
|
#
|
|
|
|
# This file is execfile()d with the current directory set to
|
|
|
|
# its containing dir.
|
|
|
|
#
|
|
|
|
# Note that not all possible configuration values are present in this
|
|
|
|
# autogenerated file.
|
|
|
|
#
|
|
|
|
# All configuration values have a default; values that are commented out
|
|
|
|
# serve to show the default.
|
|
|
|
|
|
|
|
import os
|
|
|
|
import sys
|
|
|
|
|
|
|
|
extensions = [
|
|
|
|
'openstackdocstheme',
|
|
|
|
'os_api_ref',
|
|
|
|
]
|
|
|
|
|
2018-10-18 07:11:56 -05:00
|
|
|
html_theme = 'starlingxdocs'
|
2018-09-24 12:16:02 -05:00
|
|
|
|
|
|
|
html_theme_options = {
|
|
|
|
"sidebar_dropdown": "api_ref",
|
|
|
|
"sidebar_mode": "toc",
|
|
|
|
}
|
|
|
|
|
|
|
|
# If extensions (or modules to document with autodoc) are in another directory,
|
|
|
|
# add these directories to sys.path here. If the directory is relative to the
|
|
|
|
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
|
|
|
sys.path.insert(0, os.path.abspath('../../'))
|
|
|
|
sys.path.insert(0, os.path.abspath('../'))
|
|
|
|
sys.path.insert(0, os.path.abspath('./'))
|
|
|
|
|
|
|
|
# The suffix of source filenames.
|
|
|
|
source_suffix = '.rst'
|
|
|
|
|
|
|
|
# The master toctree document.
|
|
|
|
master_doc = 'index'
|
|
|
|
|
|
|
|
# General information about the project.
|
2020-01-15 15:00:08 -08:00
|
|
|
project = u'StarlingX Fault Management'
|
2020-06-04 14:18:53 +02:00
|
|
|
|
|
|
|
# openstackdocstheme options
|
|
|
|
openstackdocs_repo_name = 'starlingx/fault'
|
|
|
|
openstackdocs_use_storyboard = True
|
|
|
|
openstackdocs_auto_name = False
|
2018-09-24 12:16:02 -05:00
|
|
|
|
|
|
|
# If true, the current module name will be prepended to all description
|
|
|
|
# unit titles (such as .. function::).
|
|
|
|
add_module_names = False
|
|
|
|
|
|
|
|
# If true, sectionauthor and moduleauthor directives will be shown in the
|
|
|
|
# output. They are ignored by default.
|
|
|
|
show_authors = False
|
|
|
|
|
|
|
|
# The name of the Pygments (syntax highlighting) style to use.
|
2020-06-04 14:18:53 +02:00
|
|
|
pygments_style = 'native'
|
2018-09-24 12:16:02 -05:00
|
|
|
|
|
|
|
# Grouping the document tree into LaTeX files. List of tuples
|
|
|
|
# (source start file, target name, title, author, documentclass
|
|
|
|
# [howto/manual]).
|
|
|
|
latex_documents = [
|
|
|
|
('index', 'stx-fault.tex', u'stx-fault API Documentation',
|
|
|
|
u'StarlingX', 'manual'),
|
|
|
|
]
|