hydra.docs module

A model for Hydra documentation strings, including inline annotations and entity references.

class hydra.docs.DocSegment

Bases: object

DocSegmentRef | DocSegmentText

REF = Name(value='ref')

TEXT = Name(value='text')

TYPE_ = Name(value='hydra.docs.DocSegment')

class hydra.docs.DocSegmentRef(value: T)

Bases: Node[hydra.packaging.EntityReference]

An inline reference to a Hydra entity

class hydra.docs.DocSegmentText(value: T)

Bases: Node[str]

A raw prose fragment, passed through verbatim