update documentation build for new PTI
Move documentation dependencies to doc/requirements.txt Change tox.ini to run sphinx-build directly, like the zuul job does. Switch from oslosphinx to openstackdocstheme. Change-Id: I079ff78edacaba673461824af770344cb3a896f2 Signed-off-by: Doug Hellmann <doug@doughellmann.com>
This commit is contained in:
parent
72a62c7f0a
commit
708d09be77
6
doc/requirements.txt
Normal file
6
doc/requirements.txt
Normal 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.1.2
|
||||||
|
sphinxcontrib-pecanwsme>=0.5
|
||||||
|
openstackdocstheme
|
@ -27,7 +27,7 @@ extensions = [
|
|||||||
'sphinxcontrib.httpdomain',
|
'sphinxcontrib.httpdomain',
|
||||||
'sphinxcontrib.pecanwsme.rest',
|
'sphinxcontrib.pecanwsme.rest',
|
||||||
'wsmeext.sphinxext',
|
'wsmeext.sphinxext',
|
||||||
'oslo.sphinx'
|
'openstackdocstheme'
|
||||||
]
|
]
|
||||||
|
|
||||||
wsme_protocols = ['restjson', 'restxml']
|
wsme_protocols = ['restjson', 'restxml']
|
||||||
@ -63,6 +63,11 @@ pygments_style = 'sphinx'
|
|||||||
# html_theme_path = ["."]
|
# html_theme_path = ["."]
|
||||||
# html_theme = '_theme'
|
# html_theme = '_theme'
|
||||||
# html_static_path = ['static']
|
# html_static_path = ['static']
|
||||||
|
html_theme = 'openstackdocs'
|
||||||
|
|
||||||
|
repository_name = 'openstack-infra/storyboard'
|
||||||
|
bug_project = '456'
|
||||||
|
html_last_updated_fmt = '%Y-%m-%d %H:%M'
|
||||||
|
|
||||||
# Output file base name for HTML help builder.
|
# Output file base name for HTML help builder.
|
||||||
htmlhelp_basename = '%sdoc' % project
|
htmlhelp_basename = '%sdoc' % project
|
||||||
|
@ -4,15 +4,9 @@ coverage>=3.6
|
|||||||
fixtures>=0.3.14
|
fixtures>=0.3.14
|
||||||
mock>=1.0
|
mock>=1.0
|
||||||
python-subunit
|
python-subunit
|
||||||
oslo.sphinx
|
|
||||||
oslotest>=1.2.0
|
oslotest>=1.2.0
|
||||||
os-testr>=1.0.0
|
os-testr>=1.0.0
|
||||||
testrepository>=0.0.18
|
testrepository>=0.0.18
|
||||||
testscenarios>=0.4,<0.5
|
testscenarios>=0.4,<0.5
|
||||||
testtools>=0.9.34
|
testtools>=0.9.34
|
||||||
posix_ipc>=0.9.8
|
posix_ipc>=0.9.8
|
||||||
|
|
||||||
|
|
||||||
# Doc requirements
|
|
||||||
sphinx>=1.1.2,<1.2
|
|
||||||
sphinxcontrib-pecanwsme>=0.5
|
|
||||||
|
6
tox.ini
6
tox.ini
@ -25,10 +25,14 @@ basepython = python2
|
|||||||
commands = {posargs}
|
commands = {posargs}
|
||||||
|
|
||||||
[testenv:docs]
|
[testenv:docs]
|
||||||
|
deps = -r{toxinidir}/doc/requirements.txt
|
||||||
commands =
|
commands =
|
||||||
rm -rf doc/html doc/build
|
rm -rf doc/html doc/build
|
||||||
rm -rf doc/source/apidoc doc/source/api
|
rm -rf doc/source/apidoc doc/source/api
|
||||||
python setup.py build_sphinx
|
# NOTE(dhellmann): We cannot use -W with sphinx-build because the
|
||||||
|
# wsme.sphinxext registers a directive that is already registered
|
||||||
|
# and that warning causes the build to exit.
|
||||||
|
sphinx-build -b html doc/source doc/build/html
|
||||||
|
|
||||||
[testenv:cover]
|
[testenv:cover]
|
||||||
commands = python setup.py testr --coverage --testr-args='{posargs}'
|
commands = python setup.py testr --coverage --testr-args='{posargs}'
|
||||||
|
Loading…
x
Reference in New Issue
Block a user