update documentation build for new PTI
Move documentation dependencies to doc/requirements.txt. Update tox.ini to run the documentation build the same way the zuul job does. Switch from oslosphinx, which is deprecated, to openstackdocstheme. Change-Id: I6ec358fecefcc6f88f498cf12cd45b77989f5c26 Signed-off-by: Doug Hellmann <doug@doughellmann.com>
This commit is contained in:
parent
940dd5c41e
commit
ef985c01c3
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
|
||||||
|
openstackdocstheme
|
@ -23,7 +23,7 @@ sys.path.insert(0, os.path.abspath('../..'))
|
|||||||
extensions = [
|
extensions = [
|
||||||
'sphinx.ext.autodoc',
|
'sphinx.ext.autodoc',
|
||||||
#'sphinx.ext.intersphinx',
|
#'sphinx.ext.intersphinx',
|
||||||
'oslosphinx'
|
'openstackdocstheme'
|
||||||
]
|
]
|
||||||
|
|
||||||
# autodoc generation is a bit aggressive and a nuisance when doing heavy
|
# autodoc generation is a bit aggressive and a nuisance when doing heavy
|
||||||
@ -57,6 +57,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/python-storyboardclient'
|
||||||
|
bug_project = '755'
|
||||||
|
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
|
||||||
|
@ -6,8 +6,6 @@ hacking>=0.9.2,<0.10
|
|||||||
|
|
||||||
coverage>=3.6
|
coverage>=3.6
|
||||||
python-subunit
|
python-subunit
|
||||||
sphinx>=1.1.2
|
|
||||||
oslosphinx
|
|
||||||
oslotest>=1.1.0.0a1
|
oslotest>=1.1.0.0a1
|
||||||
os-testr>=0.4.1
|
os-testr>=0.4.1
|
||||||
testrepository>=0.0.18
|
testrepository>=0.0.18
|
||||||
|
4
tox.ini
4
tox.ini
@ -22,7 +22,9 @@ commands = {posargs}
|
|||||||
commands = python setup.py testr --coverage --testr-args='{posargs}'
|
commands = python setup.py testr --coverage --testr-args='{posargs}'
|
||||||
|
|
||||||
[testenv:docs]
|
[testenv:docs]
|
||||||
commands = python setup.py build_sphinx
|
deps = -r{toxinidir}/doc/requirements.txt
|
||||||
|
commands =
|
||||||
|
sphinx-build -W -b html doc/source doc/build/html
|
||||||
|
|
||||||
[flake8]
|
[flake8]
|
||||||
# H803 skipped on purpose per list discussion.
|
# H803 skipped on purpose per list discussion.
|
||||||
|
Loading…
x
Reference in New Issue
Block a user