diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 0000000000..a4da2a28ed --- /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 +osprofiler>=1.4.0 # Apache-2.0 +os-api-ref>=1.4.0 # Apache-2.0 +sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD +reno>=2.5.0 # Apache-2.0 diff --git a/setup.cfg b/setup.cfg index 16276220a7..f5ef552d49 100644 --- a/setup.cfg +++ b/setup.cfg @@ -25,14 +25,6 @@ data_files = packages = magnum -[build_sphinx] -source-dir = doc/source -build-dir = doc/build -all_files = 1 -warning-is-error = 1 - -[upload_sphinx] -upload-dir = doc/build/html [compile_catalog] directory = magnum/locale diff --git a/test-requirements.txt b/test-requirements.txt index c2d586d179..b0a2d0f4c2 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -12,10 +12,8 @@ doc8>=0.6.0 # Apache-2.0 fixtures>=3.0.0 # Apache-2.0/BSD hacking!=0.13.0,<0.14,>=0.12.0 # Apache-2.0 mock>=2.0.0 # BSD -openstackdocstheme>=1.18.1 # Apache-2.0 oslotest>=3.2.0 # Apache-2.0 osprofiler>=1.4.0 # Apache-2.0 -os-api-ref>=1.4.0 # Apache-2.0 os-testr>=1.0.0 # Apache-2.0 python-subunit>=1.0.0 # Apache-2.0/BSD pytz>=2013.6 # MIT @@ -23,5 +21,3 @@ sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD testrepository>=0.0.18 # Apache-2.0/BSD testscenarios>=0.4 # Apache-2.0/BSD testtools>=2.2.0 # MIT -# releasenotes -reno>=2.5.0 # Apache-2.0 diff --git a/tox.ini b/tox.ini index bfbe35ed4e..e21f7e1758 100644 --- a/tox.ini +++ b/tox.ini @@ -133,9 +133,8 @@ commands = bandit -r magnum -x tests -n5 -ll commands = {toxinidir}/tools/cover.sh {posargs} [testenv:docs] -commands = - doc8 -e .rst specs/ doc/source/ contrib/ CONTRIBUTING.rst HACKING.rst README.rst - python setup.py build_sphinx +deps = -r{toxinidir}/doc/requirements.txt +commands = sphinx-build -W -b html doc/source doc/build/html [testenv:genconfig] commands = @@ -166,6 +165,7 @@ deps = pip_missing_reqs commands=pip-missing-reqs -d --ignore-file=magnum/tests/* magnum [testenv:releasenotes] +deps = -r{toxinidir}/doc/requirements.txt commands = rm -rf releasenotes/build sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html @@ -174,6 +174,7 @@ commands = commands = sphinx-build -a -E -W -d install-guide/build/doctrees -b html install-guide/source install-guide/build/html [testenv:api-ref] +deps = -r{toxinidir}/doc/requirements.txt commands = rm -rf api-ref/build sphinx-build -W -b html -d api-ref/build/doctrees api-ref/source api-ref/build/html