Switch to openstackdocstheme

Switch over to openstackdocstheme, update tox.ini and conf.py for this.

Remove unused extensions from conf.py.

Use separate doc/requirements file.

Build the docs using zuul.

Change-Id: Idbae35f3ba82d755e661e8f3a5ed02395682ed23
This commit is contained in:
Andreas Jaeger 2019-05-29 14:51:19 +02:00
parent d751be34dd
commit 67d59eb63b
5 changed files with 20 additions and 22 deletions

View File

@ -43,6 +43,7 @@
- project:
templates:
- openstackclient-plugin-jobs
- build-openstack-docs-pti
- check-requirements
- openstack-python-jobs
- openstack-python35-jobs

8
doc/requirements.txt Normal file
View File

@ -0,0 +1,8 @@
# 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.
# this is required for the docs
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.22.0 # Apache-2.0

View File

@ -24,12 +24,15 @@ import pbr.version
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx.ext.autodoc',
'sphinx.ext.doctest',
'sphinx.ext.todo',
'oslosphinx',
extensions = [
'openstackdocstheme',
]
# openstackdocstheme options
repository_name = 'openstack/openstackclient'
use_storyboard = True
html_theme = 'openstackdocs'
# Add any paths that contain templates here, relative to this directory.
#templates_path = ['_templates']
@ -46,17 +49,6 @@ master_doc = 'index'
project = u'OpenStack Command Line Client'
copyright = u'2012-2013 OpenStack Foundation'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
version_info = pbr.version.VersionInfo('openstackclient')
#
# The short X.Y version.
version = version_info.version_string()
# The full version, including alpha/beta/rc tags.
release = version_info.release_string()
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None

View File

@ -6,8 +6,3 @@ hacking<0.11,>=0.10.0
# this is required for the tests
oslotest>=1.10.0 # Apache-2.0
stestr>=2.0.0 # Apache-2.0
# this is required for the docs
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
oslosphinx>=4.7.0 # Apache-2.0

View File

@ -1,6 +1,6 @@
[tox]
minversion = 1.6
envlist = py35,py27,pep8
envlist = py35,py27,pep8,docs
[testenv]
deps = -r{toxinidir}/test-requirements.txt
@ -18,7 +18,9 @@ commands = {posargs}
[testenv:docs]
basepython = python3
commands = python setup.py build_sphinx
deps = -r{toxinidir}/doc/requirements.txt
commands =
sphinx-build -a -E -W -d doc/build/doctrees -b html doc/source doc/build/html
[flake8]
ignore = E123,H405