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 [3] http://lists.openstack.org/pipermail/openstack-dev/2018-March/128594.html This patch also organizes index.rst a little bit. Change-Id: I72584b21f892826f686e5df2c7c8dd596bd6cf8f
This commit is contained in:
parent
80acf5cd74
commit
671b084554
|
@ -8,6 +8,7 @@
|
|||
==============================
|
||||
|
||||
Contents:
|
||||
=========
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
@ -33,8 +34,8 @@ Contents:
|
|||
ptl
|
||||
glossary
|
||||
|
||||
====================
|
||||
Indices and tables
|
||||
====================
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
||||
* :ref:`search`
|
||||
|
|
10
setup.cfg
10
setup.cfg
|
@ -5,20 +5,12 @@ description-file =
|
|||
README.rst
|
||||
author = OpenStack
|
||||
author-email = openstack@lists.openstack.org
|
||||
home-page = http://www.openstack.org/
|
||||
home-page = https://docs.openstack.org/project-team-guide/
|
||||
classifier =
|
||||
Intended Audience :: Developers
|
||||
License :: OSI Approved :: Apache Software License
|
||||
Operating System :: POSIX :: Linux
|
||||
|
||||
[build_sphinx]
|
||||
all_files = 1
|
||||
build-dir = doc/build
|
||||
source-dir = doc/source
|
||||
warning-is-error = 1
|
||||
|
||||
[pbr]
|
||||
warnerrors = True
|
||||
|
||||
[wheel]
|
||||
universal = 1
|
||||
|
|
5
tox.ini
5
tox.ini
|
@ -7,10 +7,11 @@ skipsdist = True
|
|||
usedevelop = True
|
||||
setenv = VIRTUAL_ENV={envdir}
|
||||
install_command = pip install -U {opts} {packages}
|
||||
deps = -r{toxinidir}/requirements.txt
|
||||
deps = -r{toxinidir}/doc/requirements.txt
|
||||
|
||||
[testenv:venv]
|
||||
commands = {posargs}
|
||||
|
||||
[testenv:docs]
|
||||
commands = python setup.py build_sphinx
|
||||
deps = -r{toxinidir}/doc/requirements.txt
|
||||
commands = sphinx-build -W -b html doc/source doc/build/html
|
||||
|
|
Loading…
Reference in New Issue