From 3a8f29ed71b00fdb6920d608b0dd6714dbc09e6c Mon Sep 17 00:00:00 2001
From: caoyuan <cao.yuan@99cloud.net>
Date: Sat, 6 Jul 2019 02:15:13 +0800
Subject: [PATCH] Move doc related modules to doc/requirements.txt

Change-Id: Iedf201e211648452df29fa518c069ecf41a0acf3
---
 .gitignore                     | 2 ++
 doc/requirements.txt           | 9 +++++++++
 doc/source/conf.py             | 5 +++++
 doc/source/reference/index.rst | 2 +-
 test-requirements.txt          | 6 ------
 tox.ini                        | 9 ++++++++-
 6 files changed, 25 insertions(+), 8 deletions(-)
 create mode 100644 doc/requirements.txt

diff --git a/.gitignore b/.gitignore
index 266d242..fffab3a 100644
--- a/.gitignore
+++ b/.gitignore
@@ -56,3 +56,5 @@ ChangeLog
 # reno build
 releasenotes/build
 /doc/source/reference/api/
+releasenotes/notes/reno.cache
+RELEASENOTES.rst
diff --git a/doc/requirements.txt b/doc/requirements.txt
new file mode 100644
index 0000000..a22a5b1
--- /dev/null
+++ b/doc/requirements.txt
@@ -0,0 +1,9 @@
+# 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.
+
+openstackdocstheme>=1.18.1 # Apache-2.0
+sphinx!=1.6.6,!=1.6.7,>=1.6.2,<2.0.0;python_version=='2.7' # BSD
+sphinx!=1.6.6,!=1.6.7,>=1.6.2;python_version>='3.4' # BSD
+reno>=2.5.0 # Apache-2.0
+sphinxcontrib-apidoc>=0.2.0  # BSD
diff --git a/doc/source/conf.py b/doc/source/conf.py
index d2ab198..6bda31c 100755
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -22,6 +22,7 @@ sys.path.insert(0, os.path.abspath('../..'))
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = [
     'sphinx.ext.autodoc',
+    'sphinxcontrib.apidoc',
     #'sphinx.ext.intersphinx',
     'openstackdocstheme'
 ]
@@ -79,3 +80,7 @@ latex_documents = [
 
 # Example configuration for intersphinx: refer to the Python standard library.
 #intersphinx_mapping = {'http://docs.python.org/': None}
+
+# -- sphinxcontrib.apidoc configuration --------------------------------------
+apidoc_module_dir = '../../oslo_privsep'
+apidoc_output_dir = 'reference/api'
diff --git a/doc/source/reference/index.rst b/doc/source/reference/index.rst
index 7247d67..755d60f 100644
--- a/doc/source/reference/index.rst
+++ b/doc/source/reference/index.rst
@@ -5,4 +5,4 @@
 .. toctree::
    :maxdepth: 2
 
-   api/autoindex
+   api/modules
diff --git a/test-requirements.txt b/test-requirements.txt
index 1ce5ad1..3bfcb84 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -8,11 +8,5 @@ mock>=2.0.0 # BSD
 fixtures>=3.0.0 # Apache-2.0/BSD
 stestr>=2.0.0 # Apache-2.0
 
-# These are needed for docs generation
-openstackdocstheme>=1.18.1 # Apache-2.0
-sphinx!=1.6.6,!=1.6.7,>=1.6.2,<2.0.0;python_version=='2.7' # BSD
-sphinx!=1.6.6,!=1.6.7,>=1.6.2;python_version>='3.4' # BSD
-reno>=2.5.0 # Apache-2.0
-
 # Bandit security code scanner
 bandit>=1.1.0,<1.6.0 # Apache-2.0
diff --git a/tox.ini b/tox.ini
index e56a388..54060ba 100644
--- a/tox.ini
+++ b/tox.ini
@@ -30,7 +30,14 @@ commands = {posargs}
 
 [testenv:docs]
 basepython = python3
-commands = python setup.py build_sphinx
+whitelist_externals =
+  rm
+deps =
+  {[testenv]deps}
+  -r{toxinidir}/doc/requirements.txt
+commands =
+  rm -rf doc/build
+  sphinx-build -W -b html doc/source doc/build/html
 
 [testenv:cover]
 basepython = python3