fix footnote refernces

with the release of sphinx 8.1.3 new warnings for unused footnotes
were added. As we build with warnings as errors this broke the docs
job.

This change fixes that by removing the use of the footnote directive
where they are not used.

Change-Id: I1ac386fcdf7bd7d0f70c89cea5fe490559d80e19
This commit is contained in:
Sean Mooney
2024-11-08 21:05:17 +00:00
parent 0cb32c1588
commit 1bf26c951d
5 changed files with 16 additions and 11 deletions

View File

@@ -47,7 +47,7 @@ rely on Cinder to do the check on the volume state when it's reserving the
volume on the API level by calling attachment_create.
There are problems today when multiple volume attachments share a single
target to the volume backend. If we do not take care, multi-attach would
target to the volume backend [#]_. If we do not take care, multi-attach would
make these problems much worse. The simplest fix is to serialize all attach and
detach operations involving a shared target. To do this Cinder will expose
a volume info property of 'shared_targets', when True a lock will be

View File

@@ -259,11 +259,11 @@ References
.. [#sdk_for_placement] https://review.opendev.org/#/c/656023/
.. [#] http://lists.openstack.org/pipermail/openstack-discuss/2019-May/005810.html
http://lists.openstack.org/pipermail/openstack-discuss/2019-May/005810.html
.. [#] https://docs.openstack.org/openstacksdk/latest/user/config/configuration.html
https://docs.openstack.org/openstacksdk/latest/user/config/configuration.html
.. [#] http://eavesdrop.openstack.org/irclogs/%23openstack-sdks/%23openstack-sdks.2019-05-20.log.html#t2019-05-20T13:48:07
http://eavesdrop.openstack.org/irclogs/%23openstack-sdks/%23openstack-sdks.2019-05-20.log.html#t2019-05-20T13:48:07
History

View File

@@ -267,13 +267,13 @@ References
.. [#sdk_for_placement] https://review.opendev.org/#/c/656023/
.. [#] http://lists.openstack.org/pipermail/openstack-discuss/2019-May/005810.html
http://lists.openstack.org/pipermail/openstack-discuss/2019-May/005810.html
.. [#] https://docs.openstack.org/openstacksdk/latest/user/config/configuration.html
https://docs.openstack.org/openstacksdk/latest/user/config/configuration.html
.. [#] http://eavesdrop.openstack.org/irclogs/%23openstack-sdks/%23openstack-sdks.2019-05-20.log.html#t2019-05-20T13:48:07
http://eavesdrop.openstack.org/irclogs/%23openstack-sdks/%23openstack-sdks.2019-05-20.log.html#t2019-05-20T13:48:07
.. [#] https://review.opendev.org/#/c/662881/
https://review.opendev.org/#/c/662881/
Items Implemented In Train
--------------------------

View File

@@ -406,9 +406,6 @@ References
.. [#map-rg-to-rp] `Map request groups to resource providers
<https://github.com/openstack/nova/blob/63380a6b494e0f0f220b67b197edec836f1c5a42/nova/objects/request_spec.py#L777>`_
.. [#cy-api] `Specification for Cyborg API Version 2
<https://opendev.org/openstack/cyborg-specs/src/branch/master/specs/train/approved/cyborg-api.rst>`_
History
=======

View File

@@ -4,6 +4,14 @@ envlist = docs,pep8
skipsdist = True
[testenv]
passenv =
# LOCALE_ARCHIVE is needed when not using python from the system package
# manager (e.g. when installed with nix) to ensure the locale-archive is
# available to the tests. specifically this is needed by sphinx to build
# the docs.
LOCALE_ARCHIVE
OS_DEBUG
basepython = python3
#usedevelop = True
setenv = VIRTUAL_ENV={envdir}