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: I31dc268d810fd0ddd69a819b925226787da96ebd
This commit is contained in:
Nguyen Hai 2018-03-19 16:10:36 +09:00
parent fc60bbe734
commit 7086dc5cc7
5 changed files with 13 additions and 21 deletions

3
doc/requirements.txt Normal file
View File

@ -0,0 +1,3 @@
sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
openstackdocstheme>=1.18.1 # Apache-2.0
reno>=2.5.0 # Apache-2.0

View File

@ -2,7 +2,8 @@
Welcome to Freezer's client documentation!
==========================================
Contents:
Contents
--------
.. toctree::
:maxdepth: 2
@ -10,10 +11,10 @@ Contents:
cli/index
.. rubric:: Indices and tables
Indices and tables
------------------
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

View File

@ -40,19 +40,6 @@ keywords =
packages =
freezerclient
[build_sphinx]
source-dir = doc/source
build-dir = doc/build
all_files = 1
[entry_points]
console_scripts =
freezer = freezerclient.shell:main
[pbr]
# Have pbr generate the module indexes like sphinx autodoc
autodoc_index_modules = True
# Treat sphinx warnings as errors during the docs build; this helps us keep
# the documentation clean.
warnerrors = true

View File

@ -6,8 +6,5 @@ hacking!=0.13.0,<0.14,>=0.12.0 # Apache-2.0
coverage!=4.4,>=4.0 # Apache-2.0
mock>=2.0.0 # BSD
pylint==1.4.5 # GPLv2
sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
openstackdocstheme>=1.18.1 # Apache-2.0
testrepository>=0.0.18 # Apache-2.0/BSD
testtools>=2.2.0 # MIT
reno>=2.5.0 # Apache-2.0

View File

@ -46,8 +46,8 @@ commands =
rm -rf .testrepository
[testenv:docs]
commands =
python setup.py build_sphinx
deps = -r{toxinidir}/doc/requirements.txt
commands = sphinx-build -b html doc/source doc/build/html
[testenv:pep8]
commands = flake8 freezerclient
@ -70,6 +70,10 @@ exclude = .venv,.tox,dist,doc,*egg,releasenotes
[testenv:releasenotes]
deps =
-c{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt}
-r{toxinidir}/requirements.txt
-r{toxinidir}/doc/requirements.txt
commands = sphinx-build -a -E -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
[testenv:lower-constraints]