diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 0000000..012efb2 --- /dev/null +++ b/doc/requirements.txt @@ -0,0 +1,6 @@ +# 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. +sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD +openstackdocstheme>=1.18.1 # Apache-2.0 +reno>=2.5.0 # Apache-2.0 diff --git a/doc/source/contributor/readme.rst b/doc/source/contributor/readme.rst index e4a3ad5..db362f9 100644 --- a/doc/source/contributor/readme.rst +++ b/doc/source/contributor/readme.rst @@ -1 +1,4 @@ +============ +Introduction +============ .. include:: ../../../README.rst diff --git a/doc/source/index.rst b/doc/source/index.rst index 4e59d52..1c78a10 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -29,5 +29,4 @@ Indices and tables ------------------ * :ref:`genindex` -* :ref:`modindex` * :ref:`search` diff --git a/test-requirements.txt b/test-requirements.txt index 901e696..b16b171 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -6,11 +6,8 @@ hacking!=0.13.0,<0.14,>=0.12.0 # Apache-2.0 coverage!=4.4,>=4.0 # Apache-2.0 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 testrepository>=0.0.18 # Apache-2.0/BSD testscenarios>=0.4 # Apache-2.0/BSD testtools>=2.2.0 # MIT -reno>=2.5.0 # Apache-2.0 mock>=2.0.0 # BSD diff --git a/tox.ini b/tox.ini index c033788..93cf76e 100644 --- a/tox.ini +++ b/tox.ini @@ -24,7 +24,11 @@ commands = {posargs} commands = python setup.py test --coverage --testr-args='{posargs}' [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 -b html doc/source doc/build/html [testenv:debug] commands = oslo_debug_helper {posargs} @@ -38,4 +42,8 @@ builtins = _ exclude=.venv,.git,.tox,dist,doc,*openstack/common*,*lib/python*,*egg,build [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