summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNguyen Hai <nguyentrihai93@gmail.com>2018-03-21 00:58:42 +0900
committerNguyen Hai <nguyentrihai93@gmail.com>2018-03-26 21:53:10 +0900
commit387ac35e5750bb8d9f2db34b13c4afeaad783365 (patch)
treee59c3f96a23e8cff71e60ef175ecee96d9148648
parent230df7c36885c0d12230a87e1650f1af87d9300c (diff)
Follow the new PTI for document buildHEADmaster
For compliance with the Project Testing Interface as described in: https://governance.openstack.org/tc/reference/project-testing-interface.html http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html Remove [build_sphinx] section as described in: http://lists.openstack.org/pipermail/openstack-dev/2018-March/128594.html This patch also changes minor things in doc. Change-Id: Ib1c525d6a2f7e5477539155bfc3050b1905aad3e
Notes
Notes (review): Code-Review+2: Brian Rosmaita <rosmaita.fossdev@gmail.com> Code-Review+2: Steve McLellan <steven.j.mclellan@gmail.com> Workflow+1: Steve McLellan <steven.j.mclellan@gmail.com> Verified+2: Zuul Submitted-by: Zuul Submitted-at: Mon, 16 Apr 2018 03:00:30 +0000 Reviewed-on: https://review.openstack.org/554605 Project: openstack/python-searchlightclient Branch: refs/heads/master
-rw-r--r--doc/requirements.txt5
-rw-r--r--doc/source/index.rst6
-rw-r--r--setup.cfg9
-rw-r--r--test-requirements.txt2
-rw-r--r--tox.ini4
5 files changed, 11 insertions, 15 deletions
diff --git a/doc/requirements.txt b/doc/requirements.txt
new file mode 100644
index 0000000..d8c3cfb
--- /dev/null
+++ b/doc/requirements.txt
@@ -0,0 +1,5 @@
1# The order of packages is significant, because pip processes them in the order
2# of appearance. Changing the order has an impact on the overall integration
3# process, which may cause wedges in the gate later.
4openstackdocstheme>=1.18.1 # Apache-2.0
5sphinx!=1.6.6,>=1.6.2 # BSD
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 0159d4c..1f60c31 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -5,15 +5,17 @@ This is a client for OpenStack Searchlight API. There's a Python API
5(the :mod:`searchlightclient` module), and a command-line script 5(the :mod:`searchlightclient` module), and a command-line script
6(installed as :program:`openstack`). 6(installed as :program:`openstack`).
7 7
8Contents: 8Contents
9--------
9 10
10.. toctree:: 11.. toctree::
11 :maxdepth: 2 12 :maxdepth: 2
12 13
13 contribute/index 14 contribute/index
14 15
16
15Man Page 17Man Page
16======== 18--------
17 19
18.. toctree:: 20.. toctree::
19 :maxdepth: 1 21 :maxdepth: 1
diff --git a/setup.cfg b/setup.cfg
index 14a345e..f405031 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -35,15 +35,6 @@ openstack.search.v1 =
35setup-hooks = 35setup-hooks =
36 pbr.hooks.setup_hook 36 pbr.hooks.setup_hook
37 37
38[build_sphinx]
39source-dir = doc/source
40build-dir = doc/build
41all_files = 1
42warning-is-error = 1
43
44[upload_sphinx]
45upload-dir = doc/build/html
46
47[wheel] 38[wheel]
48universal = 1 39universal = 1
49 40
diff --git a/test-requirements.txt b/test-requirements.txt
index 924633a..42afbee 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -7,7 +7,5 @@ hacking!=0.13.0,<0.14,>=0.12.0 # Apache-2.0
7coverage!=4.4,>=4.0 # Apache-2.0 7coverage!=4.4,>=4.0 # Apache-2.0
8fixtures>=3.0.0 # Apache-2.0/BSD 8fixtures>=3.0.0 # Apache-2.0/BSD
9mock>=2.0.0 # BSD 9mock>=2.0.0 # BSD
10openstackdocstheme>=1.18.1 # Apache-2.0
11sphinx!=1.6.6,>=1.6.2 # BSD
12testrepository>=0.0.18 # Apache-2.0/BSD 10testrepository>=0.0.18 # Apache-2.0/BSD
13testtools>=2.2.0 # MIT 11testtools>=2.2.0 # MIT
diff --git a/tox.ini b/tox.ini
index 59ca260..fdfd169 100644
--- a/tox.ini
+++ b/tox.ini
@@ -38,8 +38,8 @@ passenv = OS_*
38commands = python setup.py testr --coverage --testr-args='{posargs}' 38commands = python setup.py testr --coverage --testr-args='{posargs}'
39 39
40[testenv:docs] 40[testenv:docs]
41commands= 41deps = -r{toxinidir}/doc/requirements.txt
42 python setup.py build_sphinx 42commands = sphinx-build -b html doc/source doc/build/html
43 43
44[flake8] 44[flake8]
45ignore = E123,E126,E128,E241,E265,E713,H202,H405,H238 45ignore = E123,E126,E128,E241,E265,E713,H202,H405,H238