From cd628426cdb0d1337a569bdcbba89c8f2b37b185 Mon Sep 17 00:00:00 2001 From: Nguyen Van Trung Date: Mon, 9 Jul 2018 09:14:33 +0700 Subject: [PATCH] Follow the new PTI for document build For compliance with the Project Testing Interface as described in: https://governance.openstack.org/tc/reference/project-testing-interface.html For more details information, please refer to: http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html Change-Id: Iec12cf7d3d9a84ff6ef4550d8453e822e80bc3c7 --- doc/requirements.txt | 3 +++ doc/source/docker_install.rst | 4 ++++ doc/source/index.rst | 1 + setup.cfg | 8 -------- test-requirements.txt | 3 --- tox.ini | 2 ++ 6 files changed, 10 insertions(+), 11 deletions(-) create mode 100644 doc/requirements.txt diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 000000000..23c6cf5ac --- /dev/null +++ b/doc/requirements.txt @@ -0,0 +1,3 @@ +sphinx!=1.6.6,!=1.6.7,>=1.6.5 # BSD +openstackdocstheme>=1.18.1 # Apache-2.0 +reno>=2.5.0 # Apache-2.0 diff --git a/doc/source/docker_install.rst b/doc/source/docker_install.rst index 7ace78be4..1026f2762 100644 --- a/doc/source/docker_install.rst +++ b/doc/source/docker_install.rst @@ -1,3 +1,7 @@ +============== +DOCKER INSTALL +============== + Building the image ------------------ * Run the following command diff --git a/doc/source/index.rst b/doc/source/index.rst index 1ceb6d51e..9dde9d4b6 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -15,6 +15,7 @@ Contents: installation testing_and_debugging distributed_dragonflow + docker_install distributed_dhcp pluggable_db pluggable_pubsub diff --git a/setup.cfg b/setup.cfg index de525ab89..a99f43d61 100644 --- a/setup.cfg +++ b/setup.cfg @@ -26,14 +26,6 @@ data_files = etc/neutron/ = etc/dragonflow_datapath_layout.yaml -[build_sphinx] -source-dir = doc/source -build-dir = doc/build -all_files = 1 - -[upload_sphinx] -upload-dir = doc/build/html - [compile_catalog] directory = dragonflow/locale domain = dragonflow diff --git a/test-requirements.txt b/test-requirements.txt index a9768e582..0c3be85ec 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -9,8 +9,6 @@ mock>=2.0.0 # BSD keystoneauth1>=3.4.0 # Apache-2.0 python-pytun>=2.2.1 # MIT python-subunit>=1.3.0 # Apache-2.0/BSD -sphinx!=1.6.6,!=1.6.7,>=1.6.5 # BSD -openstackdocstheme>=1.18.1 # Apache-2.0 os-testr>=1.0.0 # Apache-2.0 oslotest>=3.2.0 # Apache-2.0 testresources>=2.0.0 # Apache-2.0/BSD @@ -18,5 +16,4 @@ testscenarios>=0.4 # Apache-2.0/BSD testtools>=2.2.0 # MIT redis>=2.10.0 # MIT hiredis>=0.2.0 # BSD -reno>=2.5.0 # Apache-2.0 PrettyTable<0.8,>=0.7.2 # BSD diff --git a/tox.ini b/tox.ini index b0e93ca66..007d4c103 100644 --- a/tox.ini +++ b/tox.ini @@ -44,6 +44,8 @@ commands = commands = sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html [testenv:docs] +basepython = python3 +deps = -r{toxinidir}/doc/requirements.txt commands = sphinx-build -a -E -W -d doc/build/doctrees -b html doc/source doc/build/html [flake8]