chore: Some tweaks

Author: SilverRainZ

docs/api.rst

@@ -83,8 +83,6 @@ See :doc:`tmpl` for built-in extra-context names such as ``doc`` and
 
 .. autofunction:: sphinxnotes.render.extra_context
 
-.. autoclass:: sphinxnotes.render.ExtraContext
-
 .. autoclass:: sphinxnotes.render.ParsingPhaseExtraContext
    :members: generate
    :undoc-members:

docs/tmpl.rst

@@ -154,17 +154,17 @@ Extra Context
 -------------
 
 Templates can access additional context through **extra context**. Extra context
-must be explicitly declared using the ``:extra:`` option and loaded in the
+must be explicitly declared using the :rst:dir:`templat:extra` option and loaded in the
 template using the ``load_extra()`` function.
 
-Built-in extra context
-......................
+Built-in Extra Contexts
+.......................
 
 .. list-table::
    :header-rows: 1
 
    * - Name
-     - Available in Pahses
+     - Available in Phases
      - Description
    * - ``sphinx``
      - all
@@ -237,16 +237,16 @@ Each :py:class:`~sphinxnotes.render.Template` has a render phase controlled by
 
          .. data.render::
             :on: parsing
-            :extra: doc sphinx
+            :extra: doc env
 
             {% set doc = load_extra('doc') %}
-            {% set sphinx = load_extra('sphinx') %}
+            {% set env = load_extra('env') %}
 
             - The current document has
               {{ doc.sections | length }}
               section(s).
             - The current project has
-              {{ sphinx.env.all_docs | length }}
+              {{ env.all_docs | length }}
               document(s).
 
    ``parsed``
@@ -261,41 +261,41 @@ Each :py:class:`~sphinxnotes.render.Template` has a render phase controlled by
 
          .. data.render::
             :on: parsed
-            :extra: doc sphinx
+            :extra: doc env
 
             {% set doc = load_extra('doc') %}
-            {% set sphinx = load_extra('sphinx') %}
+            {% set env = load_extra('env') %}
 
             - The current document has
               {{ doc.sections | length }}
               section(s).
             - The current project has
-              {{ sphinx.env.all_docs | length }}
+              {{ env.all_docs | length }}
               document(s).
 
    ``resolving``
       Corresponding to :py:data:`sphinxnotes.render.Phase.Resolving`.
       Render late in the build, after references and other transforms are being
       resolved.
 
-      Choose this when the template depends on project-wide state or on document
+      Choose this when the template depends on pr
       structure that is only stable near the end of the pipeline.
 
       .. example::
          :style: grid
 
          .. data.render::
             :on: resolving
-            :extra: doc sphinx
+            :extra: doc env
 
             {% set doc = load_extra('doc') %}
-            {% set sphinx = load_extra('sphinx') %}
+            {% set env = load_extra('env') %}
 
             - The current document has
               {{ doc.sections | length }}
               section(s).
             - The current project has
-              {{ sphinx.env.all_docs | length }}
+              {{ env.all_docs | length }}
               document(s).
 
 Debugging

src/sphinxnotes/render/extractx.py

@@ -1,5 +1,5 @@
 from __future__ import annotations
-from typing import TYPE_CHECKING, override
+from typing import TYPE_CHECKING, ClassVar, override
 from abc import ABC, abstractmethod
 
 from sphinx.util.docutils import SphinxDirective, SphinxRole
@@ -156,6 +156,8 @@ class ExtraContextGenerator:
     todo: set[str]
     report: Report
 
+    env: ClassVar[BuildEnvironment]
+
     def __init__(self, node: pending_node) -> None:
         self.node = node
         self.report = Report(
@@ -243,14 +245,12 @@ def generate(self, directive: SphinxDirective | SphinxRole) -> Any:
 
 
 @extra_context('sphinx')
-class SphinxExtraContext(GlobalExtraContext):
-    app: Sphinx
-
+class SphinxAppExtraContext(GlobalExtraContext):
     @override
     def generate(self, env: BuildEnvironment) -> Any:
         from .utils.ctxproxy import proxy
 
-        return proxy(self.app)
+        return proxy(env.app)
 
 
 @extra_context('env')
@@ -276,4 +276,4 @@ def generate(self, env: BuildEnvironment) -> Any:
 
 
 def setup(app: Sphinx):
-    SphinxExtraContext.app = app
+    ...

src/sphinxnotes/render/pipeline.py

@@ -5,6 +5,7 @@
 from abc import abstractmethod, ABC
 
 from docutils import nodes
+from sphinx.environment import BuildEnvironment
 from sphinx.util import logging
 from sphinx.util.docutils import SphinxDirective, SphinxRole
 from sphinx.transforms import SphinxTransform
@@ -91,7 +92,7 @@ def queue_context(
         return pending
 
     @final
-    def render_queue(self, app: Sphinx) -> list[pending_node]:
+    def render_queue(self) -> list[pending_node]:
         """
         Try rendering all pending nodes in queue.
 
@@ -121,10 +122,13 @@ def render_queue(self, app: Sphinx) -> list[pending_node]:
                 ns.append(pending)
                 continue
 
-            # Generate global extra context for later use.
-            ExtraContextGenerator(pending).on_anytime(app.env)
 
             host = cast(Host, self)
+
+            # Generate global extra context for later use.
+            ExtraContextGenerator(pending).on_anytime(host.env)
+
+            # Perform render.
             pending.render(host)
 
             if pending.parent is None:
@@ -205,7 +209,7 @@ def run(self) -> list[nodes.Node]:
         self.queue_context(self.current_context(), self.current_template())
 
         ns = []
-        for x in self.render_queue(self.env.app):
+        for x in self.render_queue():
             if not x.rendered:
                 ns.append(x)
                 continue
@@ -233,7 +237,7 @@ def run(self) -> tuple[list[nodes.Node], list[nodes.system_message]]:
         pending.inline = True
 
         ns, msgs = [], []
-        for n in self.render_queue(self.env.app):
+        for n in self.render_queue():
             if not n.rendered:
                 ns.append(n)
                 continue
@@ -258,7 +262,7 @@ def apply(self, **kwargs):
         for pending in self.document.findall(pending_node):
             self.queue_pending_node(pending)
 
-        for n in self.render_queue(self.app):
+        for n in self.render_queue():
             ...
 
 
@@ -275,7 +279,7 @@ def process_pending_node(self, n: pending_node) -> bool:
     def apply(self, **kwargs):
         for pending in self.document.findall(pending_node):
             self.queue_pending_node(pending)
-        ns = self.render_queue(self.app)
+        ns = self.render_queue()
 
         # NOTE: Should no node left.
         assert len(ns) == 0