From 7e76f2c30780bb910b4d53387fdc9d241b2feb1b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jean-Fran=C3=A7ois=20B?= <2589111+jfbu@users.noreply.github.com> Date: Sun, 3 Jul 2022 17:07:31 +0200 Subject: [PATCH] CHANGES: improve mark-up for a few cross-referencing issues --- CHANGES | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/CHANGES b/CHANGES index 2c38017f051..58a2bc0f883 100644 --- a/CHANGES +++ b/CHANGES @@ -293,7 +293,8 @@ Features added * #10107: i18n: Allow to suppress translation warnings by adding ``#noqa`` comment to the tail of each translation message * #10252: C++, support attributes on classes, unions, and enums. -* #10253: :rst:dir:`pep` role now generates URLs based on peps.python.org +* #10253: :rst:role:`pep` role now generates URLs based on `peps.python.org + `_ Bugs fixed ---------- @@ -315,7 +316,7 @@ Bugs fixed variables/structure members * #10175: LaTeX: named footnote reference is linked to an incorrect footnote if the name is also used in the different document -* #10269: manpage: Failed to resolve the title of :ref: cross references +* #10269: manpage: Failed to resolve the title of :rst:role:`ref` cross references * #10179: i18n: suppress "rST localization" warning * #10118: imgconverter: Unnecessary availablity check is called for remote URIs * #10181: napoleon: attributes are displayed like class attributes for google @@ -347,7 +348,7 @@ Features added by an extlink, suggesting a replacement. * #9961: html: Support nested HTML elements in other HTML builders * #10013: html: Allow to change the loading method of JS via ``loading_method`` - parameter for :meth:`Sphinx.add_js_file()` + parameter for :meth:`.Sphinx.add_js_file()` * #9551: html search: "Hide Search Matches" link removes "highlight" parameter from URL * #9815: html theme: Wrap sidebar components in div to allow customizing their @@ -454,7 +455,7 @@ Incompatible changes with more docutils nodes to allow better CSS styling. It may break existing styling. * #9672: the signature of - :py:meth:`domains.py.PyObject.get_signature_prefix` has changed to + ``domains.python.PyObject.get_signature_prefix`` has changed to return a list of nodes instead of a plain string. * #9695: ``domains.js.JSObject.display_prefix`` has been changed into a method ``get_display_prefix`` which now returns a list of nodes @@ -531,7 +532,7 @@ Bugs fixed * #9775: py domain: Literal typehint was converted to a cross reference when :confval:`autodoc_typehints='description'` * #9708: needs_extension failed to check double-digit version correctly -* #9688: Fix :rst:dir:`code`` does not recognize ``:class:`` option +* #9688: Fix Sphinx patched :dudir:`code` does not recognize ``:class:`` option * #9733: Fix for logging handler flushing warnings in the middle of the docs build * #9656: Fix warnings without subtype being incorrectly suppressed @@ -551,7 +552,7 @@ Features added * #9447: html theme: Expose the version of Sphinx in the form of tuple as a template variable ``sphinx_version_tuple`` * #9594: manpage: Suppress the title of man page if description is empty -* #9445: py domain: ``:py:property:`` directive supports ``:classmethod:`` +* #9445: py domain: :rst:dir:`py:property` directive supports ``:classmethod:`` option to describe the class property * #9524: test: SphinxTestApp can take ``builddir`` as an argument * #9535: C and C++, support more fundamental types, including GNU extensions. @@ -6410,7 +6411,7 @@ Release 1.1.3 (Mar 10, 2012) * #860: Do not crash when encountering invalid doctest examples, just emit a warning. -* #864: Fix crash with some settings of `modindex_common_prefix`. +* #864: Fix crash with some settings of :confval:`modindex_common_prefix`. * #862: Fix handling of ``-D`` and ``-A`` options on Python 3.