diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 0000000..8871238 --- /dev/null +++ b/doc/requirements.txt @@ -0,0 +1,5 @@ +# 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 # BSD diff --git a/doc/source/cli/index.rst b/doc/source/cli/index.rst index fa04d72..97f6a46 100644 --- a/doc/source/cli/index.rst +++ b/doc/source/cli/index.rst @@ -1,6 +1,6 @@ -============================= - Command-line Tool Reference -============================= +=========================== +Command-line Tool Reference +=========================== In order to use the CLI, you must provide your OpenStack username, password, tenant, and auth endpoint. Use the corresponding diff --git a/test-requirements.txt b/test-requirements.txt index 3bca173..4c31bfe 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -5,8 +5,6 @@ hacking!=0.13.0,<0.14,>=0.12.0 # Apache-2.0 coverage!=4.4,>=4.0 # Apache-2.0 fixtures>=3.0.0 # Apache-2.0/BSD -openstackdocstheme>=1.18.1 # Apache-2.0 -sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD oslotest>=3.2.0 # Apache-2.0 testrepository>=0.0.18 # Apache-2.0/BSD testscenarios>=0.4 # Apache-2.0/BSD diff --git a/tox.ini b/tox.ini index 7f91547..662d1b0 100644 --- a/tox.ini +++ b/tox.ini @@ -35,6 +35,13 @@ commands = ./coverage.sh {posargs} [testenv:debug] commands = oslo_debug_helper -t solumclient/tests {posargs} +[testenv:docs] +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 + [flake8] show-source = True builtins = _