From 3c70f8f69ebbe0bd1f83cfeb84a1c79b0f01a8ee Mon Sep 17 00:00:00 2001
From: Nguyen Hai <nguyentrihai93@gmail.com>
Date: Mon, 19 Mar 2018 21:09:12 +0900
Subject: Follow the new PTI for document build

- Follow new PTI for docs build
- Add sphinxcontrib.apidoc to replace pbr autodoc

REF:
https://governance.openstack.org/tc/reference/project-testing-interface.html
http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html
http://lists.openstack.org/pipermail/openstack-dev/2018-March/128594.html

Change-Id: I078e2ed32da04303203d6c2a3e498f82b9a15939
---
 doc/requirements.txt           |  8 ++++++++
 doc/source/conf.py             | 12 +++++++++++-
 doc/source/index.rst           |  9 ++++++---
 doc/source/reference/index.rst |  2 +-
 4 files changed, 26 insertions(+), 5 deletions(-)
 create mode 100644 doc/requirements.txt

(limited to 'doc')

diff --git a/doc/requirements.txt b/doc/requirements.txt
new file mode 100644
index 0000000..0c9dba3
--- /dev/null
+++ b/doc/requirements.txt
@@ -0,0 +1,8 @@
+# The order of packages is significant, because pip processes them in the order
+# of appearance. Changing the order has an impact on the overall integration
+# process, which may cause wedges in the gate later.
+sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
+sphinxcontrib-apidoc>=0.2.0  # BSD
+reno>=2.5.0 # Apache-2.0
+openstackdocstheme>=1.18.1 # Apache-2.0
+httplib2>=0.9.1 # MIT
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 0f7099a..6233623 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -28,12 +28,22 @@ sys.path.insert(0, ROOT)
 sys.path.insert(0, BASE_DIR)
 
 extensions = [
-    'sphinx.ext.autodoc',
     'sphinx.ext.doctest',
     'sphinx.ext.coverage',
     'openstackdocstheme',
+    'sphinxcontrib.apidoc',
 ]
 
+# sphinxcontrib.apidoc options
+apidoc_module_dir = '../../troveclient'
+apidoc_output_dir = 'reference/api'
+apidoc_excluded_paths = [
+    'compat/tests/*',
+    'compat/tests',
+    'tests/*',
+    'tests']
+apidoc_separate_modules = True
+
 # openstackdocstheme options
 repository_name = 'openstack/python-troveclient'
 bug_project = 'python-troveclient'
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 22b0459..9b3e989 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -11,14 +11,17 @@
       License for the specific language governing permissions and limitations
       under the License.
 
-============================================
+===========================================
  Python bindings to the OpenStack Trove API
-============================================
+===========================================
 
 This is a client for the OpenStack Trove API. There's a Python API (the
 ``troveclient`` module), and a command-line script (``trove``). Each
 implements 100% of the OpenStack Trove API.
 
+Contents
+--------
+
 .. toctree::
    :maxdepth: 2
 
@@ -27,7 +30,7 @@ implements 100% of the OpenStack Trove API.
    reference/index
 
 Indices and tables
-==================
+------------------
 
 * :ref:`genindex`
 * :ref:`search`
diff --git a/doc/source/reference/index.rst b/doc/source/reference/index.rst
index 1d9e914..efc5e39 100644
--- a/doc/source/reference/index.rst
+++ b/doc/source/reference/index.rst
@@ -5,4 +5,4 @@
 .. toctree::
    :maxdepth: 2
 
-   api/autoindex
+   api/modules
-- 
cgit v1.2.1