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
This commit is contained in:
Nguyen Hai 2018-03-19 20:10:53 +09:00
parent 989b5e7eec
commit 2b8c717440
8 changed files with 22 additions and 18 deletions

2
doc/requirements.txt Normal file
View File

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

View File

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

View File

@ -1,7 +1,9 @@
===============================================
Welcome to python-magnumclient's documentation!
==============================================
===============================================
Contents:
Contents
--------
.. toctree::
:maxdepth: 2
@ -12,8 +14,7 @@ Contents:
contributing
Indices and tables
==================
------------------
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

View File

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

View File

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

View File

@ -54,13 +54,6 @@ openstack.container_infra.v1 =
coe_service_list = magnumclient.osc.v1.mservices:ListService
[build_sphinx]
source-dir = doc/source
build-dir = doc/build
all_files = 1
[upload_sphinx]
upload-dir = doc/build/html
[compile_catalog]
directory = magnumclient/locale
@ -78,7 +71,3 @@ output_file = magnumclient/locale/magnumclient.pot
[wheel]
universal = 1
[pbr]
autodoc_index_modules = True
warnerrors = True

View File

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

View File

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