Update theme to openstackdocstheme

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

Change-Id: Iac9f7c5fa3a832e9e3c26b4701a5685ea6252bed
This commit is contained in:
Kaifeng Wang 2018-12-18 15:08:45 +08:00
parent bd764399d4
commit 2c168e5c73
5 changed files with 24 additions and 12 deletions

View File

@ -24,8 +24,8 @@ sys.path.insert(0, os.path.abspath('../..'))
extensions = [ extensions = [
'sphinx.ext.autodoc', 'sphinx.ext.autodoc',
#'sphinx.ext.intersphinx', #'sphinx.ext.intersphinx',
'oslosphinx',
'yasfb', 'yasfb',
'openstackdocstheme',
] ]
# Feed configuration for yasfb # Feed configuration for yasfb
@ -75,6 +75,8 @@ pygments_style = 'sphinx'
# html_theme = '_theme' # html_theme = '_theme'
# html_static_path = ['static'] # html_static_path = ['static']
html_theme = 'openstackdocs'
# Output file base name for HTML help builder. # Output file base name for HTML help builder.
htmlhelp_basename = '%sdoc' % project htmlhelp_basename = '%sdoc' % project
@ -90,3 +92,8 @@ latex_documents = [
# Example configuration for intersphinx: refer to the Python standard library. # Example configuration for intersphinx: refer to the Python standard library.
#intersphinx_mapping = {'http://docs.python.org/': None} #intersphinx_mapping = {'http://docs.python.org/': None}
# openstackdocstheme options
repository_name = 'openstack/ironic-inspector-specs'
bug_project = 'ironic-inspector'
bug_tag = ''

View File

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

View File

@ -211,8 +211,12 @@ Unit test cases will be added.
References References
========== ==========
.. [#] http://dpdk.org/doc/guides-16.04/linux_gsg/nic_perf_intel_platform.html 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://docs.openstack.org/admin-guide/compute-cpu-topologies.html
.. [#] 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/ 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/

View File

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

View File

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