rendering.RenderContext
Where a prepared object appears in the generated documentation
Usage
rendering.RenderContext(
obj,
authored_name,
canonical_identity,
page_path,
level,
contained,
source_root,
output_root,
settings,
)The aliases of an object share its prepared documentation, and each has its own authored name and page. Treat the object and settings referenced by this frozen record as read-only.
Parameter Attributes
obj: gf.Object | gf.Alias-
The prepared object, or the authored alias that wraps it
authored_name: str-
The name selected for this appearance
canonical_identity: str-
The canonical object’s qualified path, shared by aliases
page_path: str | None-
The path of the containing QMD page, relative to the output directory
Nonewhen no containing page is known, or when the page’s path is absolute and not inside a known output directory. level: int-
The heading depth of this appearance
contained: bool-
Whether this appearance sits inside another object’s documentation
source_root: Path | None-
The project’s documentation source directory, or
Nonewhen unknown output_root: Path | None-
The directory the documentation is generated into, or
Noneoutside a build settings: Settings- The parser, introspection and rendering settings