Browse Source

Update theme to openstackdocstheme

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

Change-Id: Iac9f7c5fa3a832e9e3c26b4701a5685ea6252bed
Kaifeng Wang 4 months ago
parent
commit
2c168e5c73
5 changed files with 24 additions and 12 deletions
  1. 8
    1
      doc/source/conf.py
  2. 3
    3
      requirements.txt
  3. 9
    5
      specs/NUMA_node_info.rst
  4. 3
    2
      specs/Network-Interface-Resource-Info.rst
  5. 1
    1
      tox.ini

+ 8
- 1
doc/source/conf.py View File

@@ -24,8 +24,8 @@ sys.path.insert(0, os.path.abspath('../..'))
24 24
 extensions = [
25 25
     'sphinx.ext.autodoc',
26 26
     #'sphinx.ext.intersphinx',
27
-    'oslosphinx',
28 27
     'yasfb',
28
+    'openstackdocstheme',
29 29
 ]
30 30
 
31 31
 # Feed configuration for yasfb
@@ -75,6 +75,8 @@ pygments_style = 'sphinx'
75 75
 # html_theme = '_theme'
76 76
 # html_static_path = ['static']
77 77
 
78
+html_theme = 'openstackdocs'
79
+
78 80
 # Output file base name for HTML help builder.
79 81
 htmlhelp_basename = '%sdoc' % project
80 82
 
@@ -90,3 +92,8 @@ latex_documents = [
90 92
 
91 93
 # Example configuration for intersphinx: refer to the Python standard library.
92 94
 #intersphinx_mapping = {'http://docs.python.org/': None}
95
+
96
+# openstackdocstheme options
97
+repository_name = 'openstack/ironic-inspector-specs'
98
+bug_project = 'ironic-inspector'
99
+bug_tag = ''

+ 3
- 3
requirements.txt View File

@@ -1,4 +1,4 @@
1
-pbr>=0.11,<2.0
2
-oslosphinx
3
-sphinx>=1.1.2,!=1.2.0,!=1.3b1,<1.3
1
+pbr!=2.1.0,>=2.0.0
2
+sphinx!=1.6.6,<1.7.0,>=1.6.2 # BSD
3
+openstackdocstheme>=1.18.1 # Apache-2.0
4 4
 yasfb>=0.5.1

+ 9
- 5
specs/NUMA_node_info.rst View File

@@ -211,8 +211,12 @@ Unit test cases will be added.
211 211
 References
212 212
 ==========
213 213
 
214
-.. [#] http://dpdk.org/doc/guides-16.04/linux_gsg/nic_perf_intel_platform.html
215
-.. [#] http://docs.openstack.org/admin-guide/compute-cpu-topologies.html
216
-.. [#] https://en.wikipedia.org/wiki/Non-uniform_memory_access
217
-.. [#] 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
218
-.. [#] https://patchwork.kernel.org/patch/5142561/
214
+http://dpdk.org/doc/guides-16.04/linux_gsg/nic_perf_intel_platform.html
215
+
216
+http://docs.openstack.org/admin-guide/compute-cpu-topologies.html
217
+
218
+https://en.wikipedia.org/wiki/Non-uniform_memory_access
219
+
220
+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
221
+
222
+https://patchwork.kernel.org/patch/5142561/

+ 3
- 2
specs/Network-Interface-Resource-Info.rst View File

@@ -151,6 +151,7 @@ Unit test cases will be added.
151 151
 References
152 152
 ==========
153 153
 
154
-.. [1] https://www.freedesktop.org/wiki/Software/systemd/PredictableNetworkInterfaceNames/
155
-.. [2] https://linux.die.net/man/1/biosdevname
154
+https://www.freedesktop.org/wiki/Software/systemd/PredictableNetworkInterfaceNames/
155
+
156
+https://linux.die.net/man/1/biosdevname
156 157
 

+ 1
- 1
tox.ini View File

@@ -18,7 +18,7 @@ commands =
18 18
 
19 19
 [testenv:docs]
20 20
 basepython = python3
21
-commands = python setup.py build_sphinx
21
+commands = sphinx-build -W -b html doc/source doc/build/html
22 22
 
23 23
 [testenv:spelling]
24 24
 basepython = python3

Loading…
Cancel
Save