diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 00000000..8a9cfade --- /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. +openstackdocstheme>=1.18.1 # Apache-2.0 +sphinx!=1.6.6,!=1.6.7,>=1.6.5 # BSD +reno>=2.5.0 # Apache-2.0 diff --git a/setup.cfg b/setup.cfg index e7cbd0b7..26792fc9 100644 --- a/setup.cfg +++ b/setup.cfg @@ -6,7 +6,7 @@ description-file = license = Apache License, Version 2.0 author = OpenStack author-email = openstack-dev@lists.openstack.org -home-page = https://docs.openstack.org/murano/latest/ +home-page = https://docs.openstack.org/python-muranoclient/latest/ classifier = Development Status :: 4 - Beta Environment :: Console @@ -74,15 +74,6 @@ tag_build = tag_date = 0 tag_svn_revision = 0 -[build_sphinx] -source-dir = doc/source -build-dir = doc/build -all_files = 1 -warning-is-error = 1 - -[upload_sphinx] -upload-dir = doc/build/html - [wheel] universal = 1 diff --git a/test-requirements.txt b/test-requirements.txt index bc762b3f..a653d412 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -13,8 +13,3 @@ testscenarios>=0.4 # Apache-2.0/BSD testtools>=2.2.0 # MIT oslotest>=3.2.0 # Apache-2.0 os-testr>=1.0.0 # Apache-2.0 - -# doc build requirements -openstackdocstheme>=1.18.1 # Apache-2.0 -sphinx!=1.6.6,!=1.6.7,>=1.6.5 # BSD -reno>=2.5.0 # Apache-2.0 diff --git a/tox.ini b/tox.ini index aa721b2d..9db6eaa1 100644 --- a/tox.ini +++ b/tox.ini @@ -1,5 +1,5 @@ [tox] -envlist = py35,py27,pep8 +envlist = py35,py27,pep8,docs minversion = 1.6 skipsdist = True @@ -48,7 +48,19 @@ deps = flake8 commands = flake8 +[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 -W -b html doc/source doc/build/html + [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 [flake8]