Browse Source

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
tags/2.10.0
Nguyen Hai 1 year ago
parent
commit
2b8c717440
8 changed files with 22 additions and 18 deletions
  1. 2
    0
      doc/requirements.txt
  2. 5
    1
      doc/source/contributing.rst
  3. 5
    4
      doc/source/index.rst
  4. 4
    0
      doc/source/readme.rst
  5. 1
    0
      doc/source/usage.rst
  6. 0
    11
      setup.cfg
  7. 0
    2
      test-requirements.txt
  8. 5
    0
      tox.ini

+ 2
- 0
doc/requirements.txt View File

@@ -0,0 +1,2 @@
1
+sphinx!=1.6.6,>=1.6.2 # BSD
2
+openstackdocstheme>=1.18.1 # Apache-2.0

+ 5
- 1
doc/source/contributing.rst View File

@@ -1 +1,5 @@
1
-.. include:: ../../CONTRIBUTING.rst
1
+============
2
+Contributing
3
+============
4
+
5
+.. include:: ../../CONTRIBUTING.rst

+ 5
- 4
doc/source/index.rst View File

@@ -1,7 +1,9 @@
1
+===============================================
1 2
 Welcome to python-magnumclient's documentation!
2
-==============================================
3
+===============================================
3 4
 
4
-Contents:
5
+Contents
6
+--------
5 7
 
6 8
 .. toctree::
7 9
    :maxdepth: 2
@@ -12,8 +14,7 @@ Contents:
12 14
    contributing
13 15
 
14 16
 Indices and tables
15
-==================
17
+------------------
16 18
 
17 19
 * :ref:`genindex`
18
-* :ref:`modindex`
19 20
 * :ref:`search`

+ 4
- 0
doc/source/readme.rst View File

@@ -1 +1,5 @@
1
+============
2
+Introduction
3
+============
4
+
1 5
 .. include:: ../../README.rst

+ 1
- 0
doc/source/usage.rst View File

@@ -1,3 +1,4 @@
1
+===========================================
1 2
 Python bindings to the OpenStack Magnum API
2 3
 ===========================================
3 4
 

+ 0
- 11
setup.cfg View File

@@ -54,13 +54,6 @@ openstack.container_infra.v1 =
54 54
 
55 55
     coe_service_list = magnumclient.osc.v1.mservices:ListService
56 56
 
57
-[build_sphinx]
58
-source-dir = doc/source
59
-build-dir = doc/build
60
-all_files = 1
61
-
62
-[upload_sphinx]
63
-upload-dir = doc/build/html
64 57
 
65 58
 [compile_catalog]
66 59
 directory = magnumclient/locale
@@ -78,7 +71,3 @@ output_file = magnumclient/locale/magnumclient.pot
78 71
 
79 72
 [wheel]
80 73
 universal = 1
81
-
82
-[pbr]
83
-autodoc_index_modules = True
84
-warnerrors = True

+ 0
- 2
test-requirements.txt View File

@@ -6,8 +6,6 @@ bandit>=1.1.0 # Apache-2.0
6 6
 coverage!=4.4,>=4.0 # Apache-2.0
7 7
 fixtures>=3.0.0 # Apache-2.0/BSD
8 8
 python-openstackclient>=3.12.0 # Apache-2.0
9
-sphinx!=1.6.6,>=1.6.2 # BSD
10
-openstackdocstheme>=1.18.1 # Apache-2.0
11 9
 oslotest>=3.2.0 # Apache-2.0
12 10
 osprofiler>=1.4.0 # Apache-2.0
13 11
 testrepository>=0.0.18 # Apache-2.0/BSD

+ 5
- 0
tox.ini View File

@@ -48,6 +48,11 @@ commands =
48 48
   # Run security linter
49 49
   bandit -r magnumclient -x tests -n5 -ll
50 50
 
51
+[testenv:docs]
52
+deps = -r{toxinidir}/doc/requirements.txt
53
+commands =
54
+  sphinx-build -W -b html doc/source doc/build/html
55
+
51 56
 [testenv:venv]
52 57
 commands = {posargs}
53 58
 

Loading…
Cancel
Save