Cleanup docs building
a few cleanups: - Remove obsolete sections from setup.cfg - Switch to using sphinx-build - Remove install_command from tox.ini, the default is fine - Update pbr requirement - Fix build problems - Switch to py38 for testing following Victoria testing platforms Change-Id: I1ff3853020d69aeceb8b81c21ce608b269015ece
This commit is contained in:
parent
4d39e01563
commit
88cfef5d00
|
@ -3,7 +3,7 @@
|
|||
- openstack-specs-jobs
|
||||
check:
|
||||
jobs:
|
||||
- openstack-tox-py37
|
||||
- openstack-tox-py38
|
||||
gate:
|
||||
jobs:
|
||||
- openstack-tox-py37
|
||||
- openstack-tox-py38
|
||||
|
|
|
@ -1,4 +1,4 @@
|
|||
pbr>=0.6,<1.0
|
||||
pbr!=2.1.0,>=2.0.0 # Apache-2.0
|
||||
openstackdocstheme>=2.2.1 # Apache-2.0
|
||||
sphinx>=2.0.0,!=2.1.0 # BSD
|
||||
yasfb>=0.8.0
|
||||
|
|
13
setup.cfg
13
setup.cfg
|
@ -5,20 +5,9 @@ description-file =
|
|||
README.rst
|
||||
author = OpenStack
|
||||
author-email = openstack-dev@lists.openstack.org
|
||||
home-page = http://specs.openstack.org/openstack/zaqar-specs/
|
||||
home-page = https://specs.openstack.org/openstack/zaqar-specs/
|
||||
classifier =
|
||||
Environment :: OpenStack
|
||||
Intended Audience :: Developers
|
||||
License :: OSI Approved :: Apache Software License
|
||||
Operating System :: POSIX :: Linux
|
||||
|
||||
[build_sphinx]
|
||||
source-dir = doc/source
|
||||
build-dir = doc/build
|
||||
all_files = 1
|
||||
|
||||
[pbr]
|
||||
warnerrors = True
|
||||
|
||||
[upload_sphinx]
|
||||
upload-dir = doc/build/html
|
||||
|
|
|
@ -17,3 +17,5 @@
|
|||
queens/index
|
||||
rocky/index
|
||||
stein/index
|
||||
ussuri/index
|
||||
victoria/index
|
||||
|
|
|
@ -38,15 +38,18 @@ return the amount of queues in response body like "count=100".
|
|||
|
||||
API Impact
|
||||
-----------
|
||||
Query queue list
|
||||
GET: /v2/queues?with_count=true
|
||||
Query queue list:
|
||||
|
||||
RESPONSE CODE: 200
|
||||
RESPONSE BODY:
|
||||
{
|
||||
"count": 100,
|
||||
"queues": [...]
|
||||
}
|
||||
.. code-block::
|
||||
|
||||
GET: /v2/queues?with_count=true
|
||||
|
||||
RESPONSE CODE: 200
|
||||
RESPONSE BODY:
|
||||
{
|
||||
"count": 100,
|
||||
"queues": [...]
|
||||
}
|
||||
|
||||
Drawbacks
|
||||
---------
|
||||
|
@ -93,4 +96,4 @@ None
|
|||
References
|
||||
==========
|
||||
|
||||
None
|
||||
None
|
||||
|
|
|
@ -5,3 +5,5 @@
|
|||
.. toctree::
|
||||
:glob:
|
||||
:maxdepth: 2
|
||||
|
||||
encrypted-messages-in-queue
|
||||
|
|
3
tox.ini
3
tox.ini
|
@ -6,7 +6,6 @@ skipsdist = True
|
|||
[testenv]
|
||||
basepython = python3
|
||||
usedevelop = True
|
||||
install_command = pip install -U {opts} {packages}
|
||||
setenv =
|
||||
VIRTUAL_ENV={envdir}
|
||||
deps = -r{toxinidir}/requirements.txt
|
||||
|
@ -17,7 +16,7 @@ commands = stestr run --slowest {posargs}
|
|||
commands = {posargs}
|
||||
|
||||
[testenv:docs]
|
||||
commands = python setup.py build_sphinx
|
||||
commands = sphinx-build -W -b html doc/source doc/build/html
|
||||
|
||||
[testenv:spelling]
|
||||
deps =
|
||||
|
|
Loading…
Reference in New Issue