Skip to content

Index

Class PydocMarkdown

@dataclasses.dataclass
class PydocMarkdown()

[view_source]

This object represents the main configuration for Pydoc-Markdown.

loaders

A list of loader implementations that load docspec.Modules. Defaults to PythonLoader.

processors

A list of processor implementations that modify docspec.Modules. Defaults to FilterProcessor, SmartProcessor and CrossrefProcessor.

renderer

A renderer for docspec.Modules. Defaults to MarkdownRenderer.

hooks

Hooks that can be executed at certain points in the pipeline. The commands are executed with the current SHELL.

load_config

def load_config(arg: t.Union[str, dict]) -> None

[view_source]

Loads the configuration from a nested data structure or filename as specified per the data

argument. If a filename is specified, it may be a JSON, YAML or TOML file. If the name of the TOML file is pyproject.yoml, the configuration will be read from the [tool.pydoc-markdown] section.

Arguments:

  • data: A nested structure or the path to a configuration file.

init

def init(context: Context) -> None

[view_source]

Initialize all plugins with the specified context. Cannot be called multiple times. If omitted, the plugins will be initialized with a default context before the load, process or render phase.

load_modules

def load_modules() -> t.List[docspec.Module]

[view_source]

Loads modules via the loaders.

process

def process(modules: t.List[docspec.Module]) -> None

[view_source]

Process modules via the processors.

render

def render(modules: t.List[docspec.Module], run_hooks: bool = True) -> None

[view_source]

Render modules via the renderer.