Browse Source

Bring tests to current openstack release

Switch from oslosphinx to openstackdocstheme
That's what the OpenStack community is using today. Also with newer
Sphinx versions, the current approach does no longer build.

Re-add docs and requirements tests.

Switch to xena standard jobs.

Change-Id: I3f93a400bb83f4a91bd77ebe69f609949cd43ca7
changes/91/804091/5
Thomas Bechtold 3 years ago committed by Riccardo Pittau
parent
commit
21a184bff2
  1. 4
      .zuul.yaml
  2. 5
      doc/requirements.txt
  3. 7
      doc/source/conf.py
  4. 3
      tox.ini

4
.zuul.yaml

@ -1,3 +1,5 @@
- project:
templates:
- openstack-python3-wallaby-jobs
- check-requirements
- openstack-python3-xena-jobs
- publish-openstack-docs-pti

5
doc/requirements.txt

@ -1,3 +1,2 @@
sphinx!=1.6.6,!=1.6.7,>=1.6.2
oslosphinx>=4.7.0 # Apache-2.0
sphinx>=2.0.0,!=2.1.0 # BSD
openstackdocstheme>=2.2.1 # Apache-2.0

7
doc/source/conf.py

@ -22,8 +22,7 @@ sys.path.insert(0, os.path.abspath('../..'))
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = [
'sphinx.ext.autodoc',
#'sphinx.ext.intersphinx',
'oslosphinx'
'openstackdocstheme'
]
# autodoc generation is a bit aggressive and a nuisance when doing heavy
@ -57,6 +56,7 @@ pygments_style = 'sphinx'
# html_theme_path = ["."]
# html_theme = '_theme'
# html_static_path = ['static']
html_theme = 'openstackdocs'
# Output file base name for HTML help builder.
htmlhelp_basename = '%sdoc' % project
@ -73,3 +73,6 @@ latex_documents = [
# Example configuration for intersphinx: refer to the Python standard library.
#intersphinx_mapping = {'http://docs.python.org/': None}
# openstackdocstheme options
openstackdocs_repo_name = 'x/python-scciclient'

3
tox.ini

@ -49,7 +49,8 @@ basepython = python3
deps =
-r{toxinidir}/requirements.txt
-r{toxinidir}/doc/requirements.txt
commands = python setup.py build_sphinx
commands =
sphinx-build -b html doc/source doc/build/html
[flake8]
ignore = W503,W504,W605

Loading…
Cancel
Save