boilerdata_docs.types

Types.

Module Contents

Classes

IspxMappingValue

Intersphinx mapping value.

Data

SeeAlsoReference	In all examples given, there is a “None” here, like (numpy.dot, None).
SeeAlsoRelationship	The (optional) relationship is empty if not provided, else one str per line.
SingleSeeAlso	One “entry” in the See Also section.
SeeAlsoSection	The full “See Also” section, as returned by numpydoc.docscrape.NumpyDoc.
RegularSection	One list element per (unstripped) line of input.

API

class boilerdata_docs.types.IspxMappingValue

Bases: typing.NamedTuple

Intersphinx mapping value.

url: str

None

path: str | None

None

boilerdata_docs.types.SeeAlsoReference: TypeAlias

None

In all examples given, there is a “None” here, like (numpy.dot, None).

boilerdata_docs.types.SeeAlsoRelationship: TypeAlias

None

The (optional) relationship is empty if not provided, else one str per line.

boilerdata_docs.types.SingleSeeAlso: TypeAlias

None

One “entry” in the See Also section.

boilerdata_docs.types.SeeAlsoSection: TypeAlias

None

The full “See Also” section, as returned by numpydoc.docscrape.NumpyDoc.

boilerdata_docs.types.RegularSection: TypeAlias

None

One list element per (unstripped) line of input.