openstack
/
nova
Code Issues Proposed changes

doc: Use a non-numerical anchor when referencing microversions 

As called out in the review for
Ib7b9f4fd7673525129c03dc2943deedd0c7ad81f the use of a numerical anchor
causes a sequence id to be used that can change over time in the
document and thus is not stable to reference externally.

This change simply switches to a non-numerical anchor ensuring that
sphinx generates a stable anchor we can always reference.

Change-Id: I550f7fd89a13e58031b0ddfbcb4f6a5239dbf335
This commit is contained in:
Lee Yarwood 2021-03-24 11:30:02 +00:00
parent ff3fd84636
commit 387a5753de
2 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/source/user/rescue.rst
View File

@ -80,7 +80,7 @@ command:
how much time they need to shut down cleanly.
To rescue an instance that boots from a volume you need to use the
:ref:`2.87 microversion or later <2.87-microversion>`.
:ref:`2.87 microversion or later <microversion 2.87>`.
.. code-block:: console

2
nova/api/openstack/compute/rest_api_version_history.rst
View File

@ -1135,7 +1135,7 @@ Validation is only used for recognized extra spec namespaces, currently:
``hw_rng``, ``hw_video``, ``os``, ``pci_passthrough``, ``powervm``, ``quota``,
``resources``, ``trait``, and ``vmware``.
.. _2.87-microversion:
.. _microversion 2.87:
2.87 (Maximum in Ussuri and Victoria)
-------------------------------------