From 7bbce9761cae1af894f4cd70706eed0d5c4f669e Mon Sep 17 00:00:00 2001 From: "Dr. Jens Harbott" Date: Fri, 21 Jan 2022 13:10:17 +0100 Subject: [PATCH] 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 Change-Id: Ib1498a3712ec9cfd0abcb282b093f82ba0ee8128 --- tox.ini | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/tox.ini b/tox.ini index 97ff0cec..efdb1671 100644 --- a/tox.ini +++ b/tox.ini @@ -66,6 +66,9 @@ import-order-style = pep8 application-import-names = keystoneauth1 [testenv:docs] +setenv = + {[testenv]setenv} + SPHINX_APIDOC_OPTIONS=noindex,members,undoc-members,show-inheritance deps = -c{env:UPPER_CONSTRAINTS_FILE:https://opendev.org/openstack/requirements/raw/branch/master/upper-constraints.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 [testenv:pdf-docs] +setenv = + {[testenv]setenv} + SPHINX_APIDOC_OPTIONS=noindex,members,undoc-members,show-inheritance envdir = {toxworkdir}/docs deps = {[testenv:docs]deps} whitelist_externals =