Fix docs build
Avoid conflicts between apidoc generated documentation and the source code by adding "noindex" to SPHINX_APIDOC_OPTIONS. Signed-off-by: Dr. Jens Harbott <harbott@osism.tech> Change-Id: Ib1498a3712ec9cfd0abcb282b093f82ba0ee8128
This commit is contained in:
parent
112bcae1fb
commit
7bbce9761c
6
tox.ini
6
tox.ini
|
@ -66,6 +66,9 @@ import-order-style = pep8
|
||||||
application-import-names = keystoneauth1
|
application-import-names = keystoneauth1
|
||||||
|
|
||||||
[testenv:docs]
|
[testenv:docs]
|
||||||
|
setenv =
|
||||||
|
{[testenv]setenv}
|
||||||
|
SPHINX_APIDOC_OPTIONS=noindex,members,undoc-members,show-inheritance
|
||||||
deps =
|
deps =
|
||||||
-c{env:UPPER_CONSTRAINTS_FILE:https://opendev.org/openstack/requirements/raw/branch/master/upper-constraints.txt}
|
-c{env:UPPER_CONSTRAINTS_FILE:https://opendev.org/openstack/requirements/raw/branch/master/upper-constraints.txt}
|
||||||
-r{toxinidir}/doc/requirements.txt
|
-r{toxinidir}/doc/requirements.txt
|
||||||
|
@ -75,6 +78,9 @@ commands =
|
||||||
sphinx-build -W -b html -d doc/build/doctrees doc/source doc/build/html
|
sphinx-build -W -b html -d doc/build/doctrees doc/source doc/build/html
|
||||||
|
|
||||||
[testenv:pdf-docs]
|
[testenv:pdf-docs]
|
||||||
|
setenv =
|
||||||
|
{[testenv]setenv}
|
||||||
|
SPHINX_APIDOC_OPTIONS=noindex,members,undoc-members,show-inheritance
|
||||||
envdir = {toxworkdir}/docs
|
envdir = {toxworkdir}/docs
|
||||||
deps = {[testenv:docs]deps}
|
deps = {[testenv:docs]deps}
|
||||||
whitelist_externals =
|
whitelist_externals =
|
||||||
|
|
Loading…
Reference in New Issue