Cleanup py27 support
Make a few cleanups: - Remove obsolete sections from setup.cfg - Switch to using sphinx-build - Cleanup doc/source/conf.py to remove now obsolete content. - Use newer openstackdocstheme version - Remove install_command from tox.ini, the default is fine; cleanup for Python 3 only - Fix sphinx warnings Change-Id: Ic70971b3c927508cd8a69b74f0c6b152671e8f83
This commit is contained in:
Andreas Jaeger
parent
2c34ac880c
commit
c4a651a302
@ -13,16 +13,12 @@
|
||||
# limitations under the License.
|
||||
|
||||
import datetime
|
||||
import os
|
||||
import sys
|
||||
|
||||
sys.path.insert(0, os.path.abspath('../..'))
|
||||
# -- General configuration ----------------------------------------------------
|
||||
|
||||
# Add any Sphinx extension module names here, as strings. They can be
|
||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
||||
extensions = [
|
||||
'sphinx.ext.autodoc',
|
||||
#'sphinx.ext.intersphinx',
|
||||
'openstackdocstheme',
|
||||
'yasfb',
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
openstackdocstheme
|
||||
openstackdocstheme>=1.32.1
|
||||
sphinx>=2.0.0
|
||||
stestr>=2.0.0 # Apache-2.0
|
||||
testtools>=0.9.34
|
||||
|
||||
11
setup.cfg
11
setup.cfg
@ -10,14 +10,3 @@ classifier =
|
||||
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
|
||||
|
||||
[wheel]
|
||||
universal = 1
|
||||
|
||||
@ -607,7 +607,5 @@ The REST API documentation will need to be updated accordingly.
|
||||
References
|
||||
==========
|
||||
|
||||
.. [1] https://wiki.openstack.org/wiki/TripleO/TuskarJunoPlanning/TemplateBackend
|
||||
.. [2] https://etherpad.openstack.org/p/juno-summit-tripleo-tuskar-planning
|
||||
.. [3] https://review.openstack.org/#/c/97553/
|
||||
.. [4] https://review.openstack.org/#/c/97939/
|
||||
|
||||
@ -482,8 +482,5 @@ References
|
||||
.. [3] https://github.com/openstack/tripleo-heat-templates/blob/master/nova-compute-instance.yaml
|
||||
.. [4] http://docs.openstack.org/developer/heat/template_guide/environment.html
|
||||
.. [5] http://docs.openstack.org/developer/heat/template_guide/openstack.html#OS::Heat::ResourceGroup
|
||||
.. [6] http://docs.openstack.org/developer/heat/template_guide/openstack.html#OS::Heat::RandomString
|
||||
.. [7] http://lists.openstack.org/pipermail/openstack-dev/2014-July/040115.html
|
||||
.. [8] https://review.openstack.org/#/c/81666/
|
||||
.. [9] https://review.openstack.org/#/c/93319/
|
||||
.. [10] http://docs.openstack.org/developer/heat/template_guide/hot_spec.html#str-replace
|
||||
|
||||
@ -565,7 +565,6 @@ References
|
||||
.. [2] `Tendrl <https://github.com/Tendrl/documentation>`_
|
||||
.. [3] `POC tripleo-ceph-ansible <https://github.com/fultonj/tripleo-ceph-ansible>`_
|
||||
.. [4] `Experimental mistral-ansible-actions project <https://github.com/d0ugal/mistral-ansible-actions>`_
|
||||
.. [5] `Example Custom TripleO role without OpenStack services for configuration by independent Mistral workflow <https://github.com/fultonj/oooq/commit/2e2635f8cae347013737a89341b2cca24b68c28c>`_
|
||||
.. [6] `Proposed new Heat resource OS::Mistral::WorflowExecution <https://review.openstack.org/#/c/420664>`_
|
||||
.. [7] `These firewall changes must be managed in a way that does not conflict with TripleO's mechanism for managing host firewall rules and should be done before the Ceph servers are deployed. We are working on a solution to this problem.`
|
||||
.. [8] `Configuration files generated by Puppet and passed to a containerized service via a config volume <https://review.openstack.org/#/c/416421/29/docker/docker-puppet.py>`_
|
||||
|
||||
@ -438,4 +438,3 @@ References
|
||||
.. [3] `<https://github.com/Jaganathancse/Jagan/tree/master/mistral-workflow>`_
|
||||
.. [4] `nova_mem_cpu_calc.py <https://github.com/RHsyseng/hci/blob/master/scripts/nova_mem_cpu_calc.py>`_
|
||||
.. [5] `NUMA Topology in introspection data (ironic-python-agent) <https://review.openstack.org/#/c/424729/>`_
|
||||
.. [6] `Sample Environment File for Derive Params <https://review.openstack.org/#/c/457874/1/environments/derive-params/derive_parameters.yaml>`_
|
||||
|
||||
@ -24,7 +24,7 @@ Proposed Change
|
||||
Tracking Code Tech Debt with Bugs
|
||||
---------------------------------
|
||||
|
||||
Intentionally created tech debt items should have a bug[1]_ created with the
|
||||
Intentionally created tech debt items should have a bug [1]_ created with the
|
||||
`tech-debt` tag added to it. Additionally the commit message of the change
|
||||
should reference this `tech-debt` bug and if possible a comment should be added
|
||||
into the code referencing who put it in there.
|
||||
|
||||
@ -198,7 +198,7 @@ These tasks will then be collated into role specific Ansible playbooks via the
|
||||
RoleConfig output of the `overcloud` heat template, with step and release
|
||||
variables being fed in to ensure tasks are executed in the correct order.
|
||||
|
||||
As with `major upgrades` [8] a new mistral workflow and tripleoclient command
|
||||
As with `major upgrades` [8]_ a new mistral workflow and tripleoclient command
|
||||
will be introduced to generate and execute the associated Ansible tasks.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
@ -718,9 +718,7 @@ References
|
||||
|
||||
.. [0] `Review: TripleO Heat Templates: Tripleo routed networks ironic inspector, and Undercloud <https://review.openstack.org/#/c/437544>`_
|
||||
.. [1] `Spec: Routed Networks for Neutron <https://specs.openstack.org/openstack/neutron-specs/specs/newton/routed-networks.html>`_
|
||||
.. [2] `Spec: Override Network Names in TripleO Isolated Networking <https://blueprints.launchpad.net/tripleo/+spec/override-network-name>`_
|
||||
.. [3] `Review: Modify os-net-config to make changes without bouncing interface <https://review.openstack.org/#/c/152732/>`_
|
||||
.. [4] `Review: Add LLDP processing hook and new CLI commands <https://review.openstack.org/#/c/374381/>`_
|
||||
.. [5] `Blueprint: Modify TripleO Ironic Inspector to PXE Boot Via DHCP Relay <https://blueprints.launchpad.net/tripleo/+spec/tripleo-routed-networks-ironic-inspector>`_
|
||||
.. [6] `Spec: Modify TripleO Ironic Inspector to PXE Boot Via DHCP Relay <https://review.openstack.org/#/c/421011>`_
|
||||
.. [7] `Blueprint: User-specifiable Control Plane IP on TripleO Routed Isolated Networks <https://blueprints.launchpad.net/tripleo/+spec/tripleo-routed-networks-deployment>`_
|
||||
|
||||
@ -513,7 +513,6 @@ References
|
||||
==========
|
||||
|
||||
.. [0] `Blueprint: TripleO Routed Networks for Deployments <https://blueprints.launchpad.net/tripleo/+spec/tripleo-routed-networks-deployment>`_
|
||||
.. [1] `Spec: Routed Networks for Neutron <https://review.openstack.org/#/c/225384/6/specs/mitaka/routed-networks.rst>`_
|
||||
.. [2] `Spec: User-specifiable Control Plane IP on TripleO Routed Isolated Networks <https://review.openstack.org/#/c/421010/>`_
|
||||
.. [3] `Review: Modify os-net-config to make changes without bouncing interface <https://review.openstack.org/#/c/152732/>`_
|
||||
.. [4] `Review: Add support for node groups in NetConfigDataLookup <https://review.openstack.org/#/c/406641/>`_
|
||||
|
||||
7
tox.ini
7
tox.ini
@ -4,16 +4,15 @@ envlist = docs,py36
|
||||
skipsdist = True
|
||||
|
||||
[testenv]
|
||||
basepython = python3
|
||||
usedevelop = True
|
||||
setenv = VIRTUAL_ENV={envdir}
|
||||
install_command = pip install -U {opts} {packages}
|
||||
deps = -r{toxinidir}/requirements.txt
|
||||
commands = stestr run --slowest {posargs}
|
||||
|
||||
[testenv:venv]
|
||||
basepython = python3
|
||||
commands = {posargs}
|
||||
|
||||
[testenv:docs]
|
||||
basepython = python3
|
||||
commands = python setup.py build_sphinx
|
||||
commands =
|
||||
sphinx-build -W -b html doc/source doc/build/html
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user