Merge "Follow the new PTI for document build"
This commit is contained in:
commit
5627a2391a
|
@ -0,0 +1,5 @@
|
||||||
|
sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
|
||||||
|
openstackdocstheme>=1.18.1 # Apache-2.0
|
||||||
|
os-api-ref>=1.4.0 # Apache-2.0
|
||||||
|
reno>=2.5.0 # Apache-2.0
|
||||||
|
mock>=2.0.0 # BSD
|
19
setup.cfg
19
setup.cfg
|
@ -22,15 +22,6 @@ classifier =
|
||||||
packages =
|
packages =
|
||||||
neutron_lib
|
neutron_lib
|
||||||
|
|
||||||
[build_sphinx]
|
|
||||||
source-dir = doc/source
|
|
||||||
build-dir = doc/build
|
|
||||||
all_files = 1
|
|
||||||
warning-is-error = 1
|
|
||||||
|
|
||||||
[upload_sphinx]
|
|
||||||
upload-dir = doc/build/html
|
|
||||||
|
|
||||||
[compile_catalog]
|
[compile_catalog]
|
||||||
directory = neutron_lib/locale
|
directory = neutron_lib/locale
|
||||||
domain = neutron_lib
|
domain = neutron_lib
|
||||||
|
@ -44,13 +35,3 @@ input_file = neutron_lib/locale/neutron_lib.pot
|
||||||
keywords = _ gettext ngettext l_ lazy_gettext
|
keywords = _ gettext ngettext l_ lazy_gettext
|
||||||
mapping_file = babel.cfg
|
mapping_file = babel.cfg
|
||||||
output_file = neutron_lib/locale/neutron_lib.pot
|
output_file = neutron_lib/locale/neutron_lib.pot
|
||||||
|
|
||||||
[pbr]
|
|
||||||
autodoc_tree_index_modules = True
|
|
||||||
autodoc_tree_excludes =
|
|
||||||
setup.py
|
|
||||||
neutron_lib/tests
|
|
||||||
# In case neutron_lib.legacy has no actual content, this causes
|
|
||||||
# an error in sphinx autodoc, so let's exclude it.
|
|
||||||
neutron_lib/legacy
|
|
||||||
api_doc_dir = reference/modules
|
|
||||||
|
|
|
@ -8,12 +8,8 @@ coverage!=4.4,>=4.0 # Apache-2.0
|
||||||
fixtures>=3.0.0 # Apache-2.0/BSD
|
fixtures>=3.0.0 # Apache-2.0/BSD
|
||||||
flake8-import-order==0.12 # LGPLv3
|
flake8-import-order==0.12 # LGPLv3
|
||||||
python-subunit>=1.0.0 # Apache-2.0/BSD
|
python-subunit>=1.0.0 # Apache-2.0/BSD
|
||||||
sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
|
|
||||||
openstackdocstheme>=1.18.1 # Apache-2.0
|
|
||||||
oslotest>=3.2.0 # Apache-2.0
|
oslotest>=3.2.0 # Apache-2.0
|
||||||
os-api-ref>=1.4.0 # Apache-2.0
|
|
||||||
os-testr>=1.0.0 # Apache-2.0
|
os-testr>=1.0.0 # Apache-2.0
|
||||||
reno>=2.5.0 # Apache-2.0
|
|
||||||
testresources>=2.0.0 # Apache-2.0/BSD
|
testresources>=2.0.0 # Apache-2.0/BSD
|
||||||
testscenarios>=0.4 # Apache-2.0/BSD
|
testscenarios>=0.4 # Apache-2.0/BSD
|
||||||
testtools>=2.2.0 # MIT
|
testtools>=2.2.0 # MIT
|
||||||
|
|
10
tox.ini
10
tox.ini
|
@ -22,6 +22,10 @@ commands =
|
||||||
{toxinidir}/tools/check_samples.sh
|
{toxinidir}/tools/check_samples.sh
|
||||||
|
|
||||||
[testenv:releasenotes]
|
[testenv:releasenotes]
|
||||||
|
deps =
|
||||||
|
-c{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt}
|
||||||
|
-r{toxinidir}/requirements.txt
|
||||||
|
-r{toxinidir}/doc/requirements.txt
|
||||||
commands = sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
|
commands = sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
|
||||||
|
|
||||||
[testenv:venv]
|
[testenv:venv]
|
||||||
|
@ -33,7 +37,11 @@ commands =
|
||||||
coverage report
|
coverage report
|
||||||
|
|
||||||
[testenv:docs]
|
[testenv:docs]
|
||||||
commands = python setup.py build_sphinx
|
deps =
|
||||||
|
-c{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt}
|
||||||
|
-r{toxinidir}/requirements.txt
|
||||||
|
-r{toxinidir}/doc/requirements.txt
|
||||||
|
commands = sphinx-build -W -b html doc/source doc/build/html
|
||||||
|
|
||||||
[testenv:api-ref]
|
[testenv:api-ref]
|
||||||
whitelist_externals = rm
|
whitelist_externals = rm
|
||||||
|
|
Loading…
Reference in New Issue