Update docs building

* Use openstackdocstheme instead of obsolete oslosphinx
* Update requirements to current versions
* Use sphinx-build instead of pbr specific commands
* Fix wrong indend to avoid sphinx warning

Change-Id: I5aff91ec45466f25b825b1729561976db69eb188
This commit is contained in:
Andreas Jaeger 2018-09-04 20:56:03 +02:00
parent bacfe22438
commit c112ea2053
4 changed files with 14 additions and 8 deletions

View File

@ -234,10 +234,10 @@ class Depends(object):
:param rules: A list of rules, as returned by active_rules.
:param output_format: The format to print the output in. Currently
we support newline format which will print 1 package per line, and
csv format which prints a csv list.
we support newline format which will print 1 package per line, and
csv format which prints a csv list.
:return: List of all required packages regardless of whether they are
missing.
missing.
"""
packages_list = [rule[0] for rule in rules]
if output_format == 'csv':

View File

@ -24,9 +24,15 @@ sys.path.insert(0, os.path.abspath('../..'))
extensions = [
'sphinx.ext.autodoc',
'sphinxcontrib.programoutput',
'oslosphinx'
'openstackdocstheme'
]
# Setting for openstackdocstheme
html_theme = 'openstackdocs'
repository_name = 'openstack-infra/bindep'
bug_tag = ''
use_storyboard = True
# autodoc generation is a bit aggressive and a nuisance when doing heavy
# text edit cycles.
# execute "export SPHINX_DEBUG=1" in your terminal to disable

View File

@ -4,8 +4,8 @@ coverage>=3.6
fixtures>=0.3.12
mock>=2.0 # BSD
python-subunit
sphinx>=1.1.2,!=1.2.0,!=1.3b1,<1.3
oslosphinx>=2.5.0
sphinxcontrib-programoutput
testrepository>=0.0.13
testtools>=0.9.27
sphinx>1.6.1 # BSD
openstackdocstheme>=1.24.1 # Apache-2.0
sphinxcontrib-programoutput # BSD license

View File

@ -20,7 +20,7 @@ commands = {posargs}
commands = python setup.py test --coverage --testr-args='{posargs}'
[testenv:docs]
commands = python setup.py build_sphinx
commands = sphinx-build -W -b html doc/source doc/build/html
[flake8]
# E123, E125 skipped as they are invalid PEP-8.