docutils.transforms.references.IndirectHyperlinks Class Reference

Inheritance diagram for docutils.transforms.references.IndirectHyperlinks:

Collaboration diagram for docutils.transforms.references.IndirectHyperlinks:

Public Member Functions
	apply (self)
	resolve_indirect_target (self, target)
	nonexistent_indirect_target (self, target)
	circular_indirect_reference (self, target)
	indirect_target_error (self, target, explanation)
	resolve_indirect_references (self, target)
Public Member Functions inherited from docutils.transforms.Transform
	__init__ (self, document, startnode=None)

Static Public Attributes
int	default_priority = 460
Static Public Attributes inherited from docutils.transforms.Transform
	default_priority = None

Additional Inherited Members
Public Attributes inherited from docutils.transforms.Transform
	document
	startnode
	language

Detailed Description

a) Indirect external references::

       <paragraph>
           <reference refname="indirect external">
               indirect external
       <target id="id1" name="direct external"
           refuri="http://indirect">
       <target id="id2" name="indirect external"
           refname="direct external">

   The "refuri" attribute is migrated back to all indirect targets
   from the final direct target (i.e. a target not referring to
   another indirect target)::

       <paragraph>
           <reference refname="indirect external">
               indirect external
       <target id="id1" name="direct external"
           refuri="http://indirect">
       <target id="id2" name="indirect external"
           refuri="http://indirect">

   Once the attribute is migrated, the preexisting "refname" attribute
   is dropped.

b) Indirect internal references::

       <target id="id1" name="final target">
       <paragraph>
           <reference refname="indirect internal">
               indirect internal
       <target id="id2" name="indirect internal 2"
           refname="final target">
       <target id="id3" name="indirect internal"
           refname="indirect internal 2">

   Targets which indirectly refer to an internal target become one-hop
   indirect (their "refid" attributes are directly set to the internal
   target's "id"). References which indirectly refer to an internal
   target become direct internal references::

       <target id="id1" name="final target">
       <paragraph>
           <reference refid="id1">
               indirect internal
       <target id="id2" name="indirect internal 2" refid="id1">
       <target id="id3" name="indirect internal" refid="id1">

Member Function Documentation

apply()

docutils.transforms.references.IndirectHyperlinks.apply

(

self

)

Override to apply the transform to the document tree.

Reimplemented from docutils.transforms.Transform.

---

The documentation for this class was generated from the following file:

• docs/help/help-venv/lib/python3.12/site-packages/docutils/transforms/references.py