Upgrade docs
- Created doc/requirements.txt with requirements for docs,pdfs and release notes. - Updated tox.ini for docs build and added pdf-docs build. - Updated do/source/conf.py with necessary changes to build pdf. - Added sphinxcontrib-svg2pdfconverter to l-c Change-Id: I98ade2140063aa3e33ca6287da2f0052fd4c5175
This commit is contained in:
parent
7f15b2a918
commit
4055482050
|
@ -0,0 +1,2 @@
|
||||||
|
reno>=2.5.0 # Apache-2.0
|
||||||
|
sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2 # BSD
|
|
@ -63,12 +63,13 @@ pygments_style = 'sphinx'
|
||||||
# The theme to use for HTML and HTML Help pages. Major themes that come with
|
# The theme to use for HTML and HTML Help pages. Major themes that come with
|
||||||
# Sphinx are currently 'default' and 'sphinxdoc'.
|
# Sphinx are currently 'default' and 'sphinxdoc'.
|
||||||
# html_theme_path = ["."]
|
# html_theme_path = ["."]
|
||||||
# html_theme = '_theme'
|
|
||||||
# html_static_path = ['static']
|
# html_static_path = ['static']
|
||||||
|
# html_theme = '_theme'
|
||||||
# Output file base name for HTML help builder.
|
# Output file base name for HTML help builder.
|
||||||
htmlhelp_basename = '%sdoc' % project
|
htmlhelp_basename = '%sdoc' % project
|
||||||
|
|
||||||
|
latex_use_xindy = False
|
||||||
|
|
||||||
# Grouping the document tree into LaTeX files. List of tuples
|
# Grouping the document tree into LaTeX files. List of tuples
|
||||||
# (source start file, target name, title, author, documentclass
|
# (source start file, target name, title, author, documentclass
|
||||||
# [howto/manual]).
|
# [howto/manual]).
|
||||||
|
|
|
@ -121,6 +121,7 @@ six==1.14.0
|
||||||
snowballstemmer==1.2.1
|
snowballstemmer==1.2.1
|
||||||
soupsieve==2.0
|
soupsieve==2.0
|
||||||
Sphinx==1.6.2
|
Sphinx==1.6.2
|
||||||
|
sphinxcontrib-svg2pdfconverter==0.1.0
|
||||||
sphinxcontrib-websupport==1.0.1
|
sphinxcontrib-websupport==1.0.1
|
||||||
SQLAlchemy==1.3.16
|
SQLAlchemy==1.3.16
|
||||||
sqlalchemy-migrate==0.13.0
|
sqlalchemy-migrate==0.13.0
|
||||||
|
@ -147,4 +148,3 @@ WebTest==2.0.35
|
||||||
wrapt==1.10.11
|
wrapt==1.10.11
|
||||||
WSME==0.10.0
|
WSME==0.10.0
|
||||||
zipp==3.1.0
|
zipp==3.1.0
|
||||||
|
|
||||||
|
|
16
tox.ini
16
tox.ini
|
@ -41,12 +41,26 @@ commands =
|
||||||
coverage html -d ./cover --omit='*tests*'
|
coverage html -d ./cover --omit='*tests*'
|
||||||
|
|
||||||
[testenv:docs]
|
[testenv:docs]
|
||||||
commands = python setup.py build_sphinx
|
deps =
|
||||||
|
-c{env:UPPER_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master}
|
||||||
|
-r{toxinidir}/requirements.txt
|
||||||
|
-r{toxinidir}/doc/requirements.txt
|
||||||
|
commands = sphinx-build -W -b html doc/source doc/build/html
|
||||||
|
|
||||||
|
[testenv:pdf-docs]
|
||||||
|
deps = {[testenv:docs]deps}
|
||||||
|
whitelist_externals = make
|
||||||
|
commands =
|
||||||
|
sphinx-build -W -b latex doc/source doc/build/pdf
|
||||||
|
make -C doc/build/pdf
|
||||||
|
|
||||||
[testenv:debug]
|
[testenv:debug]
|
||||||
commands = oslo_debug_helper {posargs}
|
commands = oslo_debug_helper {posargs}
|
||||||
|
|
||||||
[testenv:releasenotes]
|
[testenv:releasenotes]
|
||||||
|
deps =
|
||||||
|
-c{env:UPPER_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master}
|
||||||
|
-r{toxinidir}/doc/requirements.txt
|
||||||
commands = sphinx-build -a -E -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
|
commands = sphinx-build -a -E -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
|
||||||
|
|
||||||
[flake8]
|
[flake8]
|
||||||
|
|
Loading…
Reference in New Issue