Skip to content

Better public API #3644

@pawamoy

Description

@pawamoy

MkDocs could gain at better exposing and documenting its API.

Some of it could help plugin/extension authors (reusing Markdown treeprocessors), but is not exposed. Some of it must be imported for integration within other Python tools, but is not exposed (entrypoints in __main__). Some of it is documented under API reference, some of it under Plugins, some of it is not documented.

Side note: One reason I started using MkDocs and writing mkdocstrings was to have all auto-documented objects (API autodoc) appear in the table of contents. But the default mkdocs theme does not allow that 😢

Relevant issues:

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions