livery.extensions.mkdocstrings._config¶
livery.extensions.mkdocstrings._config ¶
The python handler's tables in the site's config, the members policy applied.
The extension answers the docs extension's docs.config query with
handler_tables, which writes the handler's two tables for the
packages a config covers: their search paths and the inventories, then
the handler's options. The site's own config covers every package; a
package's preview covers that package alone, reads the paths from its
own directory, and resolves a reference it does not carry through the
published site's inventory. The docs.members answer all adds an
empty filter list, so every member is documented; public leaves the
handler's own default filter standing. A config that covers no package
with a path gets no table at all.
Functions:
| Name | Description |
|---|---|
writer |
Answer |
options |
The handler's options as the site's config writes them, by name. |
toml_value |
value as a TOML literal: a bool, a number, a string, or a list of those. |
handler_tables |
The python handler's tables for the config scope describes, as TOML. |
Attributes:
| Name | Type | Description |
|---|---|---|
HANDLER |
|
|
SITE_INVENTORY |
|
writer ¶
Answer docs.config with the function that writes the handler's tables.
The docs extension asks with the workspace root, which the answer does not depend on, and calls the answer with each config's scope.
Source code in packages/extensions/mkdocstrings/src/livery/extensions/mkdocstrings/_config.py
options ¶
The handler's options as the site's config writes them, by name.
The extension's options, then the members policy the listed
extensions answer: all adds filters, an empty list.
Source code in packages/extensions/mkdocstrings/src/livery/extensions/mkdocstrings/_config.py
toml_value ¶
value as a TOML literal: a bool, a number, a string, or a list of those.
Source code in packages/extensions/mkdocstrings/src/livery/extensions/mkdocstrings/_config.py
handler_tables ¶
The python handler's tables for the config scope describes, as TOML.
The search paths of each package the scope covers that the reference documents, in the scope's order, each reached from the config's directory; the inventories, the published site's own after the pinned ones for a preview; then the options table. Empty when no package gives a path.