`papyri.nodes:LocalRef`

source: /papyri/nodes.py :687

Signature

class LocalRef ( kind : str , path : str ) → None

Members

__delattr__
__eq__
__hash__
__init__
__iter__
__repr__
__setattr__

Summary

A reference to a document within the same bundle (same package + version).

Extended Summary

Unlike RefInfo, LocalRef omits module and version because they are always inherited from the bundle context. The renderer can construct the full URL by combining the bundle's (module, version) with (kind, path).

The link is guaranteed to exist: gen validates that the target is present before writing it.

Parameters

kind : str: Document kind: "docs", "module", "examples", etc.
path : str: Path within the bundle (e.g. "numpy.linspace" or "tutorial:index").

Aliases

papyri.gen.LocalRef