From ccd043a12975c4b033fa22b109d817b081ae45c3 Mon Sep 17 00:00:00 2001
From: Abraham Arce <abraham.arce.moreno@intel.com>
Date: Tue, 25 Sep 2018 11:45:10 -0500
Subject: [PATCH] [Doc] OpenStack API Reference Guide Staging Repos

Baseline changes to comply with OpenStack API documentation
from OpenStack Documentation Contributor Guide [0] for
the following StarlingX staging repos:

- stx-python-cinderclient
- stx-nova
- stx-glance
- stx-neutron

Changes:

- [1] How to document your OpenStack API service
- Adding SPDX-License-Identifier: Apache-2.0

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

Story: 2002712
Task: 26728

Change-Id: Ie8a142360b7c57d7ec477559757aa8295feb09ff
Signed-off-by: Abraham Arce <abraham.arce.moreno@intel.com>
---
 .gitignore               |  3 ++
 api-ref/source/conf.py   | 66 ++++++++++++++++++++++++++++++++++++++++
 api-ref/source/index.rst |  8 +++++
 doc/requirements.txt     |  3 ++
 tox.ini                  |  9 ++++++
 5 files changed, 89 insertions(+)
 create mode 100644 api-ref/source/conf.py
 create mode 100644 api-ref/source/index.rst

diff --git a/.gitignore b/.gitignore
index 894a44cc0..0bc1ec97c 100644
--- a/.gitignore
+++ b/.gitignore
@@ -66,6 +66,9 @@ instance/
 # Sphinx documentation
 docs/_build/
 
+# API Reference Guide
+api-ref/build/
+
 # PyBuilder
 target/
 
diff --git a/api-ref/source/conf.py b/api-ref/source/conf.py
new file mode 100644
index 000000000..563f0d2f2
--- /dev/null
+++ b/api-ref/source/conf.py
@@ -0,0 +1,66 @@
+#
+# SPDX-License-Identifier: Apache-2.0
+
+# stx-docs 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-docs'
+project = u'stx-docs'
+bug_project = 'starlingx'
+bug_tag = 'stx.docs'
+
+# 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-docs.tex', u'stx-docs API Documentation',
+     u'StarlingX', 'manual'),
+]
diff --git a/api-ref/source/index.rst b/api-ref/source/index.rst
new file mode 100644
index 000000000..3d9b7c704
--- /dev/null
+++ b/api-ref/source/index.rst
@@ -0,0 +1,8 @@
+======================
+stx-docs API Reference
+======================
+
+StarlingX Documentation
+
+.. toctree::
+   :maxdepth: 2
diff --git a/doc/requirements.txt b/doc/requirements.txt
index 7d9ab5500..c0f770583 100644
--- a/doc/requirements.txt
+++ b/doc/requirements.txt
@@ -1,2 +1,5 @@
 openstack-doc-tools>=1.6.0
 sphinx>=1.6.2
+
+# API Reference Guide
+os-api-ref>=1.4.0 # Apache-2.0
diff --git a/tox.ini b/tox.ini
index 4a2cc0053..3d0fbe205 100644
--- a/tox.ini
+++ b/tox.ini
@@ -20,6 +20,15 @@ deps =
 commands =
   sphinx-build -a -E -W -d doc/build/doctrees -b html doc/source doc/build/html
 
+[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
+
 [testenv:linters]
 whitelist_externals = bash
 commands =