Skip to content

Commit ac6c687

Browse files
committed
update
1 parent 4801ad8 commit ac6c687

2 files changed

Lines changed: 10 additions & 10 deletions

File tree

docs/api.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -84,19 +84,19 @@ See :doc:`tmpl` for built-in extra-context names such as ``doc`` and
8484
.. autofunction:: sphinxnotes.render.extra_context
8585

8686
.. autoclass:: sphinxnotes.render.ParsingPhaseExtraContext
87-
:members: generate
87+
:members: phase, generate
8888
:undoc-members:
8989

9090
.. autoclass:: sphinxnotes.render.ParsedPhaseExtraContext
91-
:members: generate
91+
:members: phase, generate
9292
:undoc-members:
9393

9494
.. autoclass:: sphinxnotes.render.ResolvingPhaseExtraContext
95-
:members: generate
95+
:members: phase, generate
9696
:undoc-members:
9797

9898
.. autoclass:: sphinxnotes.render.GlobalExtraContext
99-
:members: generate
99+
:members: phase, generate
100100
:undoc-members:
101101

102102
Base Roles and Directives

src/sphinxnotes/render/extractx.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,6 @@ def generate(self, *args, **kwargs) -> Any: ...
3131

3232
class ParsingPhaseExtraContext(_ExtraContext):
3333
"""Extra context generated during the :py:data:`~Phase.Parsing` phase.
34-
3534
The ``generate`` method receives the current directive or role being executed.
3635
"""
3736

@@ -43,7 +42,6 @@ def generate(self, directive: SphinxDirective | SphinxRole) -> Any: ...
4342

4443
class ParsedPhaseExtraContext(_ExtraContext):
4544
"""Extra context generated during the :py:data:`~Phase.Parsed` phase.
46-
4745
The ``generate`` method receives the current Sphinx transform.
4846
"""
4947

@@ -55,7 +53,6 @@ def generate(self, transform: SphinxTransform) -> Any: ...
5553

5654
class ResolvingPhaseExtraContext(_ExtraContext):
5755
"""Extra context generated during the :py:data:`~Phase.Resolving` phase.
58-
5956
The ``generate`` method receives the current Sphinx transform.
6057
"""
6158

@@ -67,10 +64,11 @@ def generate(self, transform: SphinxTransform) -> Any: ...
6764

6865
class GlobalExtraContext(_ExtraContext):
6966
"""Extra context available in all phases.
70-
7167
The ``generate`` method receives the Sphinx build environment.
7268
"""
7369

70+
phase = None
71+
7472
@abstractmethod
7573
def generate(self, env: BuildEnvironment) -> Any: ...
7674

@@ -177,8 +175,10 @@ def __init__(self, node: pending_node) -> None:
177175
if nonexist := requested - total:
178176
self.report.text(f'Extra contexts {nonexist} are non-exist.')
179177
if nonavail := requested - nonexist:
180-
self.report.text(f'Extra contexts {nonavail} are not available '
181-
f'at pahse {node.template.phase}.')
178+
self.report.text(
179+
f'Extra contexts {nonavail} are not available '
180+
f'at pahse {node.template.phase}.'
181+
)
182182

183183
def on_anytime(self, env: BuildEnvironment) -> None:
184184
self._generate(GlobalExtraContext, lambda ctx: ctx.generate(env))

0 commit comments

Comments
 (0)