OpenStack API Reference Guide
Baseline changes to comply with OpenStack API documentation from OpenStack Documentation Contributor Guide [0]: - [1] How to document your OpenStack API service This change was introduced and then reverted due to this abandoned commit: https://review.openstack.org/#/c/605278/ Reason was a confussion during the split of old API into the new API scheme. [0] https://docs.openstack.org/doc-contrib-guide [1] https://docs.openstack.org/doc-contrib-guide/api-guides.html Story: 2002712 Task: 26659 Change-Id: Id78d51a67bb155180bfc55908b7cc3ceb503eac7 Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
This commit is contained in:
parent
bcc938ca12
commit
46bc1cfdf9
|
@ -4,6 +4,7 @@
|
||||||
- build-openstack-docs-pti
|
- build-openstack-docs-pti
|
||||||
check:
|
check:
|
||||||
jobs:
|
jobs:
|
||||||
|
- build-openstack-api-ref
|
||||||
- build-openstack-releasenotes
|
- build-openstack-releasenotes
|
||||||
- openstack-tox-linters
|
- openstack-tox-linters
|
||||||
- openstack-tox-pep8
|
- openstack-tox-pep8
|
||||||
|
@ -12,12 +13,14 @@
|
||||||
voting: false
|
voting: false
|
||||||
gate:
|
gate:
|
||||||
jobs:
|
jobs:
|
||||||
|
- build-openstack-api-ref
|
||||||
- build-openstack-releasenotes
|
- build-openstack-releasenotes
|
||||||
- openstack-tox-linters
|
- openstack-tox-linters
|
||||||
- openstack-tox-pep8
|
- openstack-tox-pep8
|
||||||
- stx-updates-pylint
|
- stx-updates-pylint
|
||||||
post:
|
post:
|
||||||
jobs:
|
jobs:
|
||||||
|
- publish-stx-api-ref
|
||||||
- publish-stx-tox
|
- publish-stx-tox
|
||||||
- publish-stx-releasenotes
|
- publish-stx-releasenotes
|
||||||
|
|
||||||
|
|
|
@ -0,0 +1,66 @@
|
||||||
|
#
|
||||||
|
# SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
|
# stx-update 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',
|
||||||
|
]
|
||||||
|
|
||||||
|
html_theme = 'openstackdocs'
|
||||||
|
|
||||||
|
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.
|
||||||
|
repository_name = 'openstack/stx-update'
|
||||||
|
project = u'stx-update'
|
||||||
|
bug_project = 'starlingx'
|
||||||
|
bug_tag = 'stx.update'
|
||||||
|
|
||||||
|
# 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.
|
||||||
|
pygments_style = 'sphinx'
|
||||||
|
|
||||||
|
# Grouping the document tree into LaTeX files. List of tuples
|
||||||
|
# (source start file, target name, title, author, documentclass
|
||||||
|
# [howto/manual]).
|
||||||
|
latex_documents = [
|
||||||
|
('index', 'stx-update.tex', u'stx-update API Documentation',
|
||||||
|
u'StarlingX', 'manual'),
|
||||||
|
]
|
|
@ -0,0 +1,8 @@
|
||||||
|
========================
|
||||||
|
stx-update API Reference
|
||||||
|
========================
|
||||||
|
|
||||||
|
StarlingX Installation/Update/Patching/Backup/Restore
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
Loading…
Reference in New Issue