Skip to content

Commit ec3341d

Browse files
SilverRainZMiMo v2 Pro
andcommitted
docs: Add phase cross-references to ExtraContext docstrings
Co-Authored-By: MiMo v2 Pro <mimo@xiaomi.com>
1 parent 8be3c98 commit ec3341d

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

src/sphinxnotes/render/extractx.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ class ExtraContext(ABC):
2525

2626

2727
class ParsingPhaseExtraContext(ExtraContext):
28-
"""Extra context generated during the Parsing phase.
28+
"""Extra context generated during the :py:data:`~Phase.Parsing` phase.
2929
3030
The ``generate`` method receives the current directive or role being executed.
3131
"""
@@ -35,7 +35,7 @@ def generate(self, directive: SphinxDirective | SphinxRole) -> Any: ...
3535

3636

3737
class ParsedPhaseExtraContext(ExtraContext):
38-
"""Extra context generated during the Parsed phase.
38+
"""Extra context generated during the :py:data:`~Phase.Parsed` phase.
3939
4040
The ``generate`` method receives the current Sphinx transform.
4141
"""
@@ -45,7 +45,7 @@ def generate(self, transform: SphinxTransform) -> Any: ...
4545

4646

4747
class ResolvingPhaseExtraContext(ExtraContext):
48-
"""Extra context generated during the Resolving phase.
48+
"""Extra context generated during the :py:data:`~Phase.Resolving` phase.
4949
5050
The ``generate`` method receives the current Sphinx transform.
5151
"""

0 commit comments

Comments
 (0)