diff --git a/.zuul.yaml b/.zuul.yaml index 59c86aae..6c0ce033 100644 --- a/.zuul.yaml +++ b/.zuul.yaml @@ -4,6 +4,7 @@ - build-openstack-docs-pti check: jobs: + - build-openstack-api-ref - build-openstack-releasenotes - openstack-tox-linters - openstack-tox-pep8 @@ -12,12 +13,14 @@ voting: false gate: jobs: + - build-openstack-api-ref - build-openstack-releasenotes - openstack-tox-linters - openstack-tox-pep8 - stx-updates-pylint post: jobs: + - publish-stx-api-ref - publish-stx-tox - publish-stx-releasenotes diff --git a/api-ref/source/conf.py b/api-ref/source/conf.py new file mode 100644 index 00000000..a40bab8c --- /dev/null +++ b/api-ref/source/conf.py @@ -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'), +] diff --git a/api-ref/source/index.rst b/api-ref/source/index.rst new file mode 100644 index 00000000..435e2c8c --- /dev/null +++ b/api-ref/source/index.rst @@ -0,0 +1,8 @@ +======================== +stx-update API Reference +======================== + +StarlingX Installation/Update/Patching/Backup/Restore + +.. toctree:: + :maxdepth: 2