Switch to openstackdocstheme

With the recent Sphinx release the previously used oslosphinx
theme is no longer functional. It is fine to switch over
to the more openstack standard openstackdocstheme which is
maintained and working with the new Sphinx.

Move doc-specific requirements for the docs process into
a separate doc/requirements.py and remove it from test-reqiurements.

Change-Id: I075a02bb9efbfc9c39277bc8ce7330e20bf91605
This commit is contained in:
Dirk Mueller 2019-05-21 09:17:07 +02:00
parent adcaafe9f2
commit 32f9d1f049
4 changed files with 13 additions and 4 deletions

6
doc/requirements.txt Normal file
View File

@ -0,0 +1,6 @@
# 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,<2.0.0;python_version=='2.7' # BSD
sphinx!=1.6.6,!=1.6.7,>=1.6.2;python_version>='3.4' # BSD
openstackdocstheme>=1.18.1 # Apache-2.0

View File

@ -10,7 +10,7 @@ sys.path.insert(0, os.path.abspath('../..'))
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = [
'sphinx.ext.autodoc',
'oslosphinx',
'openstackdocstheme',
]
# autodoc generation is a bit aggressive and a nuisance when doing heavy
@ -40,6 +40,9 @@ add_module_names = True
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# openstackdocstheme options
repository_name = 'openstack/renderspec'
# -- Options for HTML output --------------------------------------------------
# The theme to use for HTML and HTML Help pages. Major themes that come with

View File

@ -6,5 +6,3 @@ testresources>=2.0.0 # Apache-2.0/BSD
testtools>=2.2.0 # MIT
ddt>=1.0.1 # MIT
mock>=2.0.0 # BSD
sphinx!=1.6.6,>=1.6.2 # BSD
oslosphinx>=4.7.0 # Apache-2.0

View File

@ -34,5 +34,7 @@ exclude = .venv,.git,.tox,dist,doc,*lib/python*,*egg,build
[testenv:docs]
basepython = python3
commands = python setup.py build_sphinx
deps = -r{toxinidir}/doc/requirements.txt
commands =
python setup.py build_sphinx