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 requirements - Fix problems, mainly "Could not lex literal block" - Use py38 job for Victoria cycle Change-Id: Id706786bed4b20682704d524986850b7c71e225d
This commit is contained in:
parent
9704c344c1
commit
f26534191e
|
@ -3,7 +3,7 @@
|
||||||
- openstack-specs-jobs
|
- openstack-specs-jobs
|
||||||
check:
|
check:
|
||||||
jobs:
|
jobs:
|
||||||
- openstack-tox-py37
|
- openstack-tox-py38
|
||||||
gate:
|
gate:
|
||||||
jobs:
|
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
|
openstackdocstheme>=2.2.1 # Apache-2.0
|
||||||
sphinx>=2.0.0,!=2.1.0 # BSD
|
sphinx>=2.0.0,!=2.1.0 # BSD
|
||||||
yasfb>=0.8.0
|
yasfb>=0.8.0
|
||||||
|
|
11
setup.cfg
11
setup.cfg
|
@ -11,14 +11,3 @@ classifier =
|
||||||
Intended Audience :: Developers
|
Intended Audience :: Developers
|
||||||
License :: OSI Approved :: Apache Software License
|
License :: OSI Approved :: Apache Software License
|
||||||
Operating System :: POSIX :: Linux
|
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
|
|
||||||
|
|
|
@ -275,7 +275,7 @@ For example, given the :ref:`Puppet <capabilities-ex-puppet>` and
|
||||||
|
|
||||||
Which would return:
|
Which would return:
|
||||||
|
|
||||||
.. code-block:: json
|
.. code-block::
|
||||||
|
|
||||||
{
|
{
|
||||||
'deployment': ['puppet', 'docker']
|
'deployment': ['puppet', 'docker']
|
||||||
|
@ -284,7 +284,7 @@ Which would return:
|
||||||
A similar version of the call exists if the
|
A similar version of the call exists if the
|
||||||
:ref:`capabilities-annotation-type` annotation is used:
|
:ref:`capabilities-annotation-type` annotation is used:
|
||||||
|
|
||||||
.. code-block:: json
|
.. code-block::
|
||||||
|
|
||||||
{
|
{
|
||||||
'OS::TripleO::Controller': ['puppet/controller.yaml',
|
'OS::TripleO::Controller': ['puppet/controller.yaml',
|
||||||
|
|
|
@ -24,7 +24,7 @@ or even from ceilometer, the signaling request may have a predefined body,
|
||||||
which is not compatible with the json format expected by the workflow resource.
|
which is not compatible with the json format expected by the workflow resource.
|
||||||
The os::mistral::workflow expects the body to be in this format:
|
The os::mistral::workflow expects the body to be in this format:
|
||||||
|
|
||||||
.. code-block:: json
|
.. code-block::
|
||||||
|
|
||||||
{
|
{
|
||||||
"input":{
|
"input":{
|
||||||
|
@ -37,7 +37,7 @@ The os::mistral::workflow expects the body to be in this format:
|
||||||
|
|
||||||
however, ceilometer, for example, sends this body in the request:
|
however, ceilometer, for example, sends this body in the request:
|
||||||
|
|
||||||
.. code-block:: json
|
.. code-block::
|
||||||
|
|
||||||
{
|
{
|
||||||
"severity": "low",
|
"severity": "low",
|
||||||
|
@ -134,4 +134,4 @@ Work Items
|
||||||
|
|
||||||
Dependencies
|
Dependencies
|
||||||
============
|
============
|
||||||
None
|
None
|
||||||
|
|
|
@ -119,7 +119,7 @@ template:
|
||||||
We will add a default policy rule for this resource to be limited to
|
We will add a default policy rule for this resource to be limited to
|
||||||
administrators.
|
administrators.
|
||||||
|
|
||||||
.. code-block:: json
|
.. code-block::
|
||||||
|
|
||||||
"resource_types:OS::Cinder::Quota": "rule:project_admin"
|
"resource_types:OS::Cinder::Quota": "rule:project_admin"
|
||||||
|
|
||||||
|
|
|
@ -165,7 +165,7 @@ template:
|
||||||
A default policy rule will be added for this resource to be limited to
|
A default policy rule will be added for this resource to be limited to
|
||||||
administrators.
|
administrators.
|
||||||
|
|
||||||
.. code-block:: json
|
.. code-block::
|
||||||
|
|
||||||
"resource_types:OS::Neutron::Quota": "rule:project_admin"
|
"resource_types:OS::Neutron::Quota": "rule:project_admin"
|
||||||
|
|
||||||
|
|
|
@ -179,7 +179,7 @@ updated. Otherwise, the project's quota will be updated.
|
||||||
A default policy rule will be added for this resource to be limited to
|
A default policy rule will be added for this resource to be limited to
|
||||||
administrators.
|
administrators.
|
||||||
|
|
||||||
.. code-block:: json
|
.. code-block::
|
||||||
|
|
||||||
"resource_types:OS::Nova::Quota": "rule:project_admin"
|
"resource_types:OS::Nova::Quota": "rule:project_admin"
|
||||||
|
|
||||||
|
|
3
tox.ini
3
tox.ini
|
@ -6,7 +6,6 @@ skipsdist = True
|
||||||
[testenv]
|
[testenv]
|
||||||
basepython = python3
|
basepython = python3
|
||||||
usedevelop = True
|
usedevelop = True
|
||||||
install_command = pip install -U {opts} {packages}
|
|
||||||
setenv =
|
setenv =
|
||||||
VIRTUAL_ENV={envdir}
|
VIRTUAL_ENV={envdir}
|
||||||
deps = -r{toxinidir}/requirements.txt
|
deps = -r{toxinidir}/requirements.txt
|
||||||
|
@ -20,7 +19,7 @@ commands =
|
||||||
commands = {posargs}
|
commands = {posargs}
|
||||||
|
|
||||||
[testenv:docs]
|
[testenv:docs]
|
||||||
commands = python setup.py build_sphinx
|
commands = sphinx-build -W -a -b html doc/source doc/build/html
|
||||||
|
|
||||||
[testenv:spelling]
|
[testenv:spelling]
|
||||||
deps =
|
deps =
|
||||||
|
|
Loading…
Reference in New Issue