diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 00000000..e009c0df --- /dev/null +++ b/doc/requirements.txt @@ -0,0 +1,8 @@ +# 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. + +openstackdocstheme>=1.18.1 # Apache-2.0 +sphinx!=1.6.6,!=1.6.7,>=1.6.2,<2.0.0;python_version=='2.7' # BSD +sphinx!=1.6.6,!=1.6.7,>=1.6.2;python_version>='3.4' # BSD +reno>=2.5.0 # Apache-2.0 diff --git a/doc/source/index.rst b/doc/source/index.rst index 59ecaa58..defed7a4 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -56,9 +56,3 @@ Table of Contents developer/index elements specs/README - -.. # just link this on the dev page -.. toctree:: - :hidden: - - api/autoindex diff --git a/test-requirements.txt b/test-requirements.txt index 39957c96..334dcff0 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -12,12 +12,4 @@ oslotest>=3.2.0 # Apache-2.0 testrepository>=0.0.18 # Apache-2.0/BSD testtools>=2.2.0 # MIT -# Doc requirements -sphinx!=1.6.6,!=1.6.7,>=1.6.2,<2.0.0;python_version=='2.7' # BSD -sphinx!=1.6.6,!=1.6.7,>=1.6.2;python_version>='3.4' # BSD -openstackdocstheme>=1.18.1 # Apache-2.0 - -# releasenotes -reno>=2.5.0 # Apache-2.0 - coverage!=4.4,>=4.0 # Apache-2.0 diff --git a/tox.ini b/tox.ini index 64769724..9708c622 100644 --- a/tox.ini +++ b/tox.ini @@ -8,6 +8,7 @@ usedevelop = True install_command = pip install {opts} {packages} deps= -c{env:UPPER_CONSTRAINTS_FILE:https://opendev.org/openstack/requirements/raw/branch/master/upper-constraints.txt} + -r{toxinidir}/doc/requirements.txt -r{toxinidir}/requirements.txt -r{toxinidir}/test-requirements.txt commands= @@ -46,7 +47,11 @@ commands = python setup.py test --coverage --coverage-package-name diskimage_bui [testenv:docs] basepython = python3 -commands = python setup.py build_sphinx +whitelist_externals = + rm +commands = + rm -rf doc/build + sphinx-build -W -b html doc/source doc/build/html {posargs} [testenv:releasenotes] basepython = python3