API Reference

Note

WIP

sphinxnotes.render.pipeline

copyright:

Copyright 2026 by the Shengyu Zhang.

license:

BSD, see LICENSE for details.

This module defines pipeline for rendering data to nodes.

The Pipline

1. Define context: BaseDataSource generates a pending_node, which contains:

   • Context

   • Template for rendering data to markup text

   • Possible extra contexts

   See also BaseDataSource.

2. Render data: the pending_node nodes will be rendered (by calling pending_node.render()) at some point, depending on pending_node.template.phase.

   The one who calls pending_node.render is called Host. The Host host is responsible for rendering the markup text into docutils nodes (See MarkupRenderer).

   Phases:

   Phase.Parsing:

   Called by BaseDataSource (‘s subclasses)

   Phase.Parsed:

   Called by ParsedHookTransform.

   Phase.Resolving:

   Called by ResolvingHookTransform.

How context be rendered list[nodes.Node]

See also

ctxnodes.pending_node.render().