summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNguyen Hai <nguyentrihai93@gmail.com>2018-03-19 20:10:53 +0900
committerNguyen Hai <nguyentrihai93@gmail.com>2018-03-27 13:50:16 +0900
commit2b8c717440de40ae8e94c936edf0483b9aa0cd65 (patch)
tree363fb49a7b8f0450e67318299321d2db4955ed27
parent989b5e7eec92c51e602f554fbfeecebdbedd70b5 (diff)
Follow the new PTI for document build
For compliance with the Project Testing Interface as described in: [1] https://governance.openstack.org/tc/reference/project-testing-interface.html [2] http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html Remove the '[build_sphinx]' and '[pbr]' sections as described in: http://lists.openstack.org/pipermail/openstack-dev/2018-March/128594.html Change-Id: I65b35db580e029bb0639c7b4bd1cb7c3b0395542
Notes
Notes (review): Code-Review+2: Spyros Trigazis <strigazi@gmail.com> Workflow+1: Spyros Trigazis <strigazi@gmail.com> Verified+2: Zuul Submitted-by: Zuul Submitted-at: Tue, 27 Mar 2018 08:46:29 +0000 Reviewed-on: https://review.openstack.org/554197 Project: openstack/python-magnumclient Branch: refs/heads/master
-rw-r--r--doc/requirements.txt2
-rw-r--r--doc/source/contributing.rst6
-rw-r--r--doc/source/index.rst9
-rw-r--r--doc/source/readme.rst4
-rw-r--r--doc/source/usage.rst1
-rw-r--r--setup.cfg11
-rw-r--r--test-requirements.txt2
-rw-r--r--tox.ini5
8 files changed, 22 insertions, 18 deletions
diff --git a/doc/requirements.txt b/doc/requirements.txt
new file mode 100644
index 0000000..592236b
--- /dev/null
+++ b/doc/requirements.txt
@@ -0,0 +1,2 @@
1sphinx!=1.6.6,>=1.6.2 # BSD
2openstackdocstheme>=1.18.1 # Apache-2.0
diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst
index 8cb3146..1f5ca23 100644
--- a/doc/source/contributing.rst
+++ b/doc/source/contributing.rst
@@ -1 +1,5 @@
1.. include:: ../../CONTRIBUTING.rst \ No newline at end of file 1============
2Contributing
3============
4
5.. include:: ../../CONTRIBUTING.rst
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 5201159..4bbfa54 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -1,7 +1,9 @@
1===============================================
1Welcome to python-magnumclient's documentation! 2Welcome to python-magnumclient's documentation!
2============================================== 3===============================================
3 4
4Contents: 5Contents
6--------
5 7
6.. toctree:: 8.. toctree::
7 :maxdepth: 2 9 :maxdepth: 2
@@ -12,8 +14,7 @@ Contents:
12 contributing 14 contributing
13 15
14Indices and tables 16Indices and tables
15================== 17------------------
16 18
17* :ref:`genindex` 19* :ref:`genindex`
18* :ref:`modindex`
19* :ref:`search` 20* :ref:`search`
diff --git a/doc/source/readme.rst b/doc/source/readme.rst
index a6210d3..5c28058 100644
--- a/doc/source/readme.rst
+++ b/doc/source/readme.rst
@@ -1 +1,5 @@
1============
2Introduction
3============
4
1.. include:: ../../README.rst 5.. include:: ../../README.rst
diff --git a/doc/source/usage.rst b/doc/source/usage.rst
index 93c1f94..f6b411d 100644
--- a/doc/source/usage.rst
+++ b/doc/source/usage.rst
@@ -1,3 +1,4 @@
1===========================================
1Python bindings to the OpenStack Magnum API 2Python bindings to the OpenStack Magnum API
2=========================================== 3===========================================
3 4
diff --git a/setup.cfg b/setup.cfg
index 6a464b1..c42a184 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -54,13 +54,6 @@ openstack.container_infra.v1 =
54 54
55 coe_service_list = magnumclient.osc.v1.mservices:ListService 55 coe_service_list = magnumclient.osc.v1.mservices:ListService
56 56
57[build_sphinx]
58source-dir = doc/source
59build-dir = doc/build
60all_files = 1
61
62[upload_sphinx]
63upload-dir = doc/build/html
64 57
65[compile_catalog] 58[compile_catalog]
66directory = magnumclient/locale 59directory = magnumclient/locale
@@ -78,7 +71,3 @@ output_file = magnumclient/locale/magnumclient.pot
78 71
79[wheel] 72[wheel]
80universal = 1 73universal = 1
81
82[pbr]
83autodoc_index_modules = True
84warnerrors = True
diff --git a/test-requirements.txt b/test-requirements.txt
index 9062afa..72fed3f 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -6,8 +6,6 @@ bandit>=1.1.0 # Apache-2.0
6coverage!=4.4,>=4.0 # Apache-2.0 6coverage!=4.4,>=4.0 # Apache-2.0
7fixtures>=3.0.0 # Apache-2.0/BSD 7fixtures>=3.0.0 # Apache-2.0/BSD
8python-openstackclient>=3.12.0 # Apache-2.0 8python-openstackclient>=3.12.0 # Apache-2.0
9sphinx!=1.6.6,>=1.6.2 # BSD
10openstackdocstheme>=1.18.1 # Apache-2.0
11oslotest>=3.2.0 # Apache-2.0 9oslotest>=3.2.0 # Apache-2.0
12osprofiler>=1.4.0 # Apache-2.0 10osprofiler>=1.4.0 # Apache-2.0
13testrepository>=0.0.18 # Apache-2.0/BSD 11testrepository>=0.0.18 # Apache-2.0/BSD
diff --git a/tox.ini b/tox.ini
index 1065215..f19a338 100644
--- a/tox.ini
+++ b/tox.ini
@@ -48,6 +48,11 @@ commands =
48 # Run security linter 48 # Run security linter
49 bandit -r magnumclient -x tests -n5 -ll 49 bandit -r magnumclient -x tests -n5 -ll
50 50
51[testenv:docs]
52deps = -r{toxinidir}/doc/requirements.txt
53commands =
54 sphinx-build -W -b html doc/source doc/build/html
55
51[testenv:venv] 56[testenv:venv]
52commands = {posargs} 57commands = {posargs}
53 58