From 2c168e5c73fdd81bb6af8d3423b1b39e80640b33 Mon Sep 17 00:00:00 2001
From: Kaifeng Wang <kaifeng.w@gmail.com>
Date: Tue, 18 Dec 2018 15:08:45 +0800
Subject: [PATCH] Update theme to openstackdocstheme

Some invalid reference issues are exposed after switching to
openstackdocstheme, fixed as well.

Change-Id: Iac9f7c5fa3a832e9e3c26b4701a5685ea6252bed
---
 doc/source/conf.py                        |  9 ++++++++-
 requirements.txt                          |  6 +++---
 specs/NUMA_node_info.rst                  | 14 +++++++++-----
 specs/Network-Interface-Resource-Info.rst |  5 +++--
 tox.ini                                   |  2 +-
 5 files changed, 24 insertions(+), 12 deletions(-)

diff --git a/doc/source/conf.py b/doc/source/conf.py
index a1b0d1b..e2fbcab 100755
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -24,8 +24,8 @@ sys.path.insert(0, os.path.abspath('../..'))
 extensions = [
     'sphinx.ext.autodoc',
     #'sphinx.ext.intersphinx',
-    'oslosphinx',
     'yasfb',
+    'openstackdocstheme',
 ]
 
 # Feed configuration for yasfb
@@ -75,6 +75,8 @@ pygments_style = 'sphinx'
 # html_theme = '_theme'
 # html_static_path = ['static']
 
+html_theme = 'openstackdocs'
+
 # Output file base name for HTML help builder.
 htmlhelp_basename = '%sdoc' % project
 
@@ -90,3 +92,8 @@ latex_documents = [
 
 # Example configuration for intersphinx: refer to the Python standard library.
 #intersphinx_mapping = {'http://docs.python.org/': None}
+
+# openstackdocstheme options
+repository_name = 'openstack/ironic-inspector-specs'
+bug_project = 'ironic-inspector'
+bug_tag = ''
diff --git a/requirements.txt b/requirements.txt
index 152f742..842fd8e 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -1,4 +1,4 @@
-pbr>=0.11,<2.0
-oslosphinx
-sphinx>=1.1.2,!=1.2.0,!=1.3b1,<1.3
+pbr!=2.1.0,>=2.0.0
+sphinx!=1.6.6,<1.7.0,>=1.6.2 # BSD
+openstackdocstheme>=1.18.1 # Apache-2.0
 yasfb>=0.5.1
diff --git a/specs/NUMA_node_info.rst b/specs/NUMA_node_info.rst
index ea7dc5d..2d1c93a 100644
--- a/specs/NUMA_node_info.rst
+++ b/specs/NUMA_node_info.rst
@@ -211,8 +211,12 @@ Unit test cases will be added.
 References
 ==========
 
-.. [#] http://dpdk.org/doc/guides-16.04/linux_gsg/nic_perf_intel_platform.html
-.. [#] http://docs.openstack.org/admin-guide/compute-cpu-topologies.html
-.. [#] https://en.wikipedia.org/wiki/Non-uniform_memory_access
-.. [#] http://www.linuxsecrets.com/blog/6managing-linux-systems/2015/10/01/1658-how-to-identify-a-pci-slot-to-physical-socket-in-a-multi-processor-system-with-linux
-.. [#] https://patchwork.kernel.org/patch/5142561/
+http://dpdk.org/doc/guides-16.04/linux_gsg/nic_perf_intel_platform.html
+
+http://docs.openstack.org/admin-guide/compute-cpu-topologies.html
+
+https://en.wikipedia.org/wiki/Non-uniform_memory_access
+
+http://www.linuxsecrets.com/blog/6managing-linux-systems/2015/10/01/1658-how-to-identify-a-pci-slot-to-physical-socket-in-a-multi-processor-system-with-linux
+
+https://patchwork.kernel.org/patch/5142561/
diff --git a/specs/Network-Interface-Resource-Info.rst b/specs/Network-Interface-Resource-Info.rst
index c1f4788..f230c47 100644
--- a/specs/Network-Interface-Resource-Info.rst
+++ b/specs/Network-Interface-Resource-Info.rst
@@ -151,6 +151,7 @@ Unit test cases will be added.
 References
 ==========
 
-.. [1] https://www.freedesktop.org/wiki/Software/systemd/PredictableNetworkInterfaceNames/
-.. [2] https://linux.die.net/man/1/biosdevname
+https://www.freedesktop.org/wiki/Software/systemd/PredictableNetworkInterfaceNames/
+
+https://linux.die.net/man/1/biosdevname
 
diff --git a/tox.ini b/tox.ini
index 469095b..02c523c 100644
--- a/tox.ini
+++ b/tox.ini
@@ -18,7 +18,7 @@ commands =
 
 [testenv:docs]
 basepython = python3
-commands = python setup.py build_sphinx
+commands = sphinx-build -W -b html doc/source doc/build/html
 
 [testenv:spelling]
 basepython = python3