Follow the new PTI for document build

For compliance with the Project Testing Interface as described in:
https://governance.openstack.org/tc/reference/project-testing-interface.html
http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html

Remove [build_sphinx] section as described in:
http://lists.openstack.org/pipermail/openstack-dev/2018-March/128594.html

This patch also changes minor things in doc.

Change-Id: Ib1c525d6a2f7e5477539155bfc3050b1905aad3e
This commit is contained in:
Nguyen Hai 2018-03-21 00:58:42 +09:00
parent 230df7c368
commit 387ac35e57
5 changed files with 11 additions and 15 deletions

5
doc/requirements.txt Normal file
View File

@ -0,0 +1,5 @@
# The order of packages is significant, because pip processes them in the order
# of appearance. Changing the order has an impact on the overall integration
# process, which may cause wedges in the gate later.
openstackdocstheme>=1.18.1 # Apache-2.0
sphinx!=1.6.6,>=1.6.2 # BSD

View File

@ -5,15 +5,17 @@ This is a client for OpenStack Searchlight API. There's a Python API
(the :mod:`searchlightclient` module), and a command-line script
(installed as :program:`openstack`).
Contents:
Contents
--------
.. toctree::
:maxdepth: 2
contribute/index
Man Page
========
--------
.. toctree::
:maxdepth: 1

View File

@ -35,15 +35,6 @@ openstack.search.v1 =
setup-hooks =
pbr.hooks.setup_hook
[build_sphinx]
source-dir = doc/source
build-dir = doc/build
all_files = 1
warning-is-error = 1
[upload_sphinx]
upload-dir = doc/build/html
[wheel]
universal = 1

View File

@ -7,7 +7,5 @@ hacking!=0.13.0,<0.14,>=0.12.0 # Apache-2.0
coverage!=4.4,>=4.0 # Apache-2.0
fixtures>=3.0.0 # Apache-2.0/BSD
mock>=2.0.0 # BSD
openstackdocstheme>=1.18.1 # Apache-2.0
sphinx!=1.6.6,>=1.6.2 # BSD
testrepository>=0.0.18 # Apache-2.0/BSD
testtools>=2.2.0 # MIT

View File

@ -38,8 +38,8 @@ passenv = OS_*
commands = python setup.py testr --coverage --testr-args='{posargs}'
[testenv:docs]
commands=
python setup.py build_sphinx
deps = -r{toxinidir}/doc/requirements.txt
commands = sphinx-build -b html doc/source doc/build/html
[flake8]
ignore = E123,E126,E128,E241,E265,E713,H202,H405,H238