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:
parent
989b5e7eec
commit
2b8c717440
2
doc/requirements.txt
Normal file
2
doc/requirements.txt
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
sphinx!=1.6.6,>=1.6.2 # BSD
|
||||||
|
openstackdocstheme>=1.18.1 # Apache-2.0
|
@ -1 +1,5 @@
|
|||||||
|
============
|
||||||
|
Contributing
|
||||||
|
============
|
||||||
|
|
||||||
.. include:: ../../CONTRIBUTING.rst
|
.. include:: ../../CONTRIBUTING.rst
|
@ -1,7 +1,9 @@
|
|||||||
|
===============================================
|
||||||
Welcome to python-magnumclient's documentation!
|
Welcome to python-magnumclient's documentation!
|
||||||
==============================================
|
===============================================
|
||||||
|
|
||||||
Contents:
|
Contents
|
||||||
|
--------
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
@ -12,8 +14,7 @@ Contents:
|
|||||||
contributing
|
contributing
|
||||||
|
|
||||||
Indices and tables
|
Indices and tables
|
||||||
==================
|
------------------
|
||||||
|
|
||||||
* :ref:`genindex`
|
* :ref:`genindex`
|
||||||
* :ref:`modindex`
|
|
||||||
* :ref:`search`
|
* :ref:`search`
|
||||||
|
@ -1 +1,5 @@
|
|||||||
|
============
|
||||||
|
Introduction
|
||||||
|
============
|
||||||
|
|
||||||
.. include:: ../../README.rst
|
.. include:: ../../README.rst
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
|
===========================================
|
||||||
Python bindings to the OpenStack Magnum API
|
Python bindings to the OpenStack Magnum API
|
||||||
===========================================
|
===========================================
|
||||||
|
|
||||||
|
11
setup.cfg
11
setup.cfg
@ -54,13 +54,6 @@ openstack.container_infra.v1 =
|
|||||||
|
|
||||||
coe_service_list = magnumclient.osc.v1.mservices:ListService
|
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]
|
[compile_catalog]
|
||||||
directory = magnumclient/locale
|
directory = magnumclient/locale
|
||||||
@ -78,7 +71,3 @@ output_file = magnumclient/locale/magnumclient.pot
|
|||||||
|
|
||||||
[wheel]
|
[wheel]
|
||||||
universal = 1
|
universal = 1
|
||||||
|
|
||||||
[pbr]
|
|
||||||
autodoc_index_modules = True
|
|
||||||
warnerrors = True
|
|
||||||
|
@ -6,8 +6,6 @@ bandit>=1.1.0 # Apache-2.0
|
|||||||
coverage!=4.4,>=4.0 # Apache-2.0
|
coverage!=4.4,>=4.0 # Apache-2.0
|
||||||
fixtures>=3.0.0 # Apache-2.0/BSD
|
fixtures>=3.0.0 # Apache-2.0/BSD
|
||||||
python-openstackclient>=3.12.0 # Apache-2.0
|
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
|
oslotest>=3.2.0 # Apache-2.0
|
||||||
osprofiler>=1.4.0 # Apache-2.0
|
osprofiler>=1.4.0 # Apache-2.0
|
||||||
testrepository>=0.0.18 # Apache-2.0/BSD
|
testrepository>=0.0.18 # Apache-2.0/BSD
|
||||||
|
5
tox.ini
5
tox.ini
@ -48,6 +48,11 @@ commands =
|
|||||||
# Run security linter
|
# Run security linter
|
||||||
bandit -r magnumclient -x tests -n5 -ll
|
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]
|
[testenv:venv]
|
||||||
commands = {posargs}
|
commands = {posargs}
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user