Fumerov0.3.0
Components

PdxAttribute

An attribute row, and the list it sits in

outputPath=Path('.')

Directory the .mdx tree is written into.

dialectDialect=Dialect.AUTO

The docstring dialect griffe parses with.

excludetuple[str, ...]=()

A name on the left, its type and assigned value on the right, prose underneath. The same shape as a parameter row, because an attribute is the same kind of thing: something named, something typed, something said about it.

An undocumented attribute is written self-closing, as the third row above is. It still carries its name, type and value, which is everything the source knows about it.

value is the assigned value as source text, so a default of Path('.') reads the way it was written rather than as a repr. links maps the documented type names in the annotation to their pages, and the component splices those links into the highlighted type.

API Reference

PdxAttribute

One attribute: a name, a type, an assigned value, and a description. Rendered as a row inside a PdxAttributes list.

Prop

Type

PdxAttributes

The list the rows sit in. Attributes render as one list rather than a card each, because a card apiece turns a handful of one-liners into a column of boxes.

Prop

Type

On this page