diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 00000000..693e1103 --- /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.5 # BSD diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst index 8cb3146f..1f5ca23c 100644 --- a/doc/source/contributing.rst +++ b/doc/source/contributing.rst @@ -1 +1,5 @@ -.. include:: ../../CONTRIBUTING.rst \ No newline at end of file +============ +Contributing +============ + +.. include:: ../../CONTRIBUTING.rst diff --git a/doc/source/index.rst b/doc/source/index.rst index 1067ef12..3dcd0e50 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -35,5 +35,4 @@ Indices and tables ------------------ * :ref:`genindex` -* :ref:`modindex` * :ref:`search` diff --git a/setup.cfg b/setup.cfg index 77e1b2e8..28a188e6 100644 --- a/setup.cfg +++ b/setup.cfg @@ -6,7 +6,7 @@ description-file = README.rst author = OpenStack author-email = openstack-dev@lists.openstack.org -home-page = http://docs.openstack.org/developer/tosca-parser/ +home-page = http://docs.openstack.org/tosca-parser/ classifier = Environment :: OpenStack Intended Audience :: Information Technology @@ -28,14 +28,6 @@ packages = console_scripts = tosca-parser = toscaparser.shell:main -[build_sphinx] -source-dir = doc/source -build-dir = doc/build -all_files = 1 - -[upload_sphinx] -upload-dir = doc/build/html - [compile_catalog] directory = toscaparser/locale domain = toscaparser diff --git a/test-requirements.txt b/test-requirements.txt index 7091256b..8f582893 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -5,9 +5,7 @@ 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 oslotest>=3.2.0 # Apache-2.0 -openstackdocstheme>=1.18.1 # Apache-2.0 python-subunit>=1.0.0 # Apache-2.0/BSD -sphinx!=1.6.6,!=1.6.7,>=1.6.5 # BSD testrepository>=0.0.18 # Apache-2.0/BSD testscenarios>=0.4 # Apache-2.0/BSD testtools>=2.2.0 # MIT diff --git a/tox.ini b/tox.ini index 60e40e4e..3f9f0943 100644 --- a/tox.ini +++ b/tox.ini @@ -26,7 +26,8 @@ commands = {posargs} commands = python setup.py test --coverage --coverage-package-name=toscaparser --testr-args='{posargs}' [testenv:docs] -commands = python setup.py build_sphinx +deps = -r{toxinidir}/doc/requirements.txt +commands = sphinx-build -b html doc/source doc/build/html [testenv:debug] commands = oslo_debug_helper -t toscaparser/tests {posargs}