[3.12] Docs: Resolve Sphinx warnings in dis.rst (GH-108476) (#108546)

Docs: Resolve Sphinx warnings in dis.rst (GH-108476)

- Link to the code objects reference
- Suppress link to deliberately undocumented builtins.__build_class__
- Suppress links for example methods
(cherry picked from commit cb1184280b3fb369a07abb4153aa36829cf1df9b)

Co-authored-by: Erlend E. Aasland <erlend@python.org>

diff --git a/Doc/library/dis.rst b/Doc/library/dis.rst
index 085fd2baba55c06cdb50ab9127a7b2e024ff5a23..6fadccfc44f92f44567dd939319659fa67b4ab78 100644 (file)
--- a/Doc/library/dis.rst
+++ b/Doc/library/dis.rst
@@ -43,13 +43,13 @@ interpreter.
       adaptive bytecode can be shown by passing ``adaptive=True``.
 
 
-Example: Given the function :func:`myfunc`::
+Example: Given the function :func:`!myfunc`::
 
    def myfunc(alist):
        return len(alist)
 
 the following command can be used to display the disassembly of
-:func:`myfunc`:
+:func:`!myfunc`:
 
 .. doctest::
 
@@ -793,7 +793,7 @@ iterations of the loop.
 
 .. opcode:: LOAD_BUILD_CLASS
 
-   Pushes :func:`builtins.__build_class__` onto the stack.  It is later called
+   Pushes :func:`!builtins.__build_class__` onto the stack.  It is later called
    to construct a class.
 
 
@@ -851,14 +851,14 @@ iterations of the loop.
 .. opcode:: STORE_NAME (namei)
 
    Implements ``name = STACK.pop()``. *namei* is the index of *name* in the attribute
-   :attr:`co_names` of the code object. The compiler tries to use
-   :opcode:`STORE_FAST` or :opcode:`STORE_GLOBAL` if possible.
+   :attr:`!co_names` of the :ref:`code object <code-objects>`.
+   The compiler tries to use :opcode:`STORE_FAST` or :opcode:`STORE_GLOBAL` if possible.
 
 
 .. opcode:: DELETE_NAME (namei)
 
-   Implements ``del name``, where *namei* is the index into :attr:`co_names`
-   attribute of the code object.
+   Implements ``del name``, where *namei* is the index into :attr:`!co_names`
+   attribute of the :ref:`code object <code-objects>`.
 
 
 .. opcode:: UNPACK_SEQUENCE (count)
@@ -897,7 +897,8 @@ iterations of the loop.
       value = STACK.pop()
       obj.name = value
 
-   where *namei* is the index of name in :attr:`co_names`.
+   where *namei* is the index of name in :attr:`!co_names` of the
+   :ref:`code object <code-objects>`.
 
 .. opcode:: DELETE_ATTR (namei)
 
@@ -906,7 +907,8 @@ iterations of the loop.
       obj = STACK.pop()
       del obj.name
 
-   where *namei* is the index of name into :attr:`co_names`.
+   where *namei* is the index of name into :attr:`!co_names` of the
+   :ref:`code object <code-objects>`.
 
 
 .. opcode:: STORE_GLOBAL (namei)

diff --git a/Doc/reference/datamodel.rst b/Doc/reference/datamodel.rst
index 4c2d03eacdc277d78b406a23b7913abe3fc4bd91..362ac752149c05177a8ec6000891e6c0b088a767 100644 (file)
--- a/Doc/reference/datamodel.rst
+++ b/Doc/reference/datamodel.rst
@@ -1039,12 +1039,14 @@ A few types used internally by the interpreter are exposed to the user. Their
 definitions may change with future versions of the interpreter, but they are
 mentioned here for completeness.
 
-.. index:: bytecode, object; code, code object
 
+.. _code-objects:
 
 Code objects
 ^^^^^^^^^^^^
 
+.. index:: bytecode, object; code, code object
+
 Code objects represent *byte-compiled* executable Python code, or :term:`bytecode`.
 The difference between a code object and a function object is that the function
 object contains an explicit reference to the function's globals (the module in

diff --git a/Doc/tools/.nitignore b/Doc/tools/.nitignore
index 2ba307df21d85369e65fcd8684b528537bb6953a..13fc06983dac46c879d11692c4046d286b7445b0 100644 (file)
--- a/Doc/tools/.nitignore
+++ b/Doc/tools/.nitignore
@@ -64,7 +64,6 @@ Doc/library/dbm.rst
 Doc/library/decimal.rst
 Doc/library/devmode.rst
 Doc/library/difflib.rst
-Doc/library/dis.rst
 Doc/library/doctest.rst
 Doc/library/email.charset.rst
 Doc/library/email.compat32-message.rst