Browse Source

[Doc] 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

[0] https://docs.openstack.org/doc-contrib-guide
[1] https://docs.openstack.org/doc-contrib-guide/api-guides.html

Story: 2002712
Task: 25749

Change-Id: I54d5637c1611c824eac3f3cb45a00559f2a28ab7
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
changes/66/599466/7
Abraham Arce 3 years ago
committed by Scott Rifenbark
parent
commit
a59b5954d1
5 changed files with 99 additions and 0 deletions
  1. +3
    -0
      .gitignore
  2. +75
    -0
      api-ref/source/conf.py
  3. +9
    -0
      api-ref/source/index.rst
  4. +3
    -0
      doc/requirements.txt
  5. +9
    -0
      tox.ini

+ 3
- 0
.gitignore View File

@ -27,3 +27,6 @@ doc/build/
# Release Notes Management
releasenotes/build
# API Reference Guide
api-ref/build/

+ 75
- 0
api-ref/source/conf.py View File

@ -0,0 +1,75 @@
# 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.
#
# stx-ha 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-ha'
project = u'stx-ha'
bug_project = 'starlingx'
bug_tag = 'stx.ha'
# 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-ha.tex', u'stx-ha API Documentation',
u'StarlingX', 'manual'),
]

+ 9
- 0
api-ref/source/index.rst View File

@ -0,0 +1,9 @@
=======================
stx-ha API Reference
=======================
This is the API Reference for the StarlingX High Availability / Process
Monitoring / Service Management
.. toctree::
:maxdepth: 2

+ 3
- 0
doc/requirements.txt View File

@ -3,3 +3,6 @@ openstackdocstheme>=1.19.0 # Apache-2.0
# Release Notes
reno>=0.1.1 # Apache-2.0
# API Reference Guide
os-api-ref>=1.4.0 # Apache-2.0

+ 9
- 0
tox.ini View File

@ -61,3 +61,12 @@ whitelist_externals = rm
envdir = {toxworkdir}/releasenotes
deps = -r{toxinidir}/doc/requirements.txt
commands = reno new {posargs}
[testenv:api-ref]
basepython = python3
deps =
-r{toxinidir}/doc/requirements.txt
commands =
rm -rf api-ref/build
sphinx-build -W -b html -d api-ref/build/doctrees api-ref/source api-ref/build/html
whitelist_externals = rm

Loading…
Cancel
Save