Usage¤

This is the documentation for the NEW Python handler.

To read the documentation for the LEGACY handler, go to the legacy handler documentation.

Installation¤

You can install this handler as a mkdocstrings extra:

pyproject.toml

# PEP 621 dependencies declaration
# adapt to your dependencies manager
[project]
dependencies = [
    "mkdocstrings[python]>=0.18",
]

You can also explicitly depend on the handler:

pyproject.toml

# PEP 621 dependencies declaration
# adapt to your dependencies manager
[project]
dependencies = [
    "mkdocstrings-python",
]

The Python handler is the default mkdocstrings handler. You can change the default handler, or explicitely set the Python handler as default by defining the default_handler configuration option of mkdocstrings in mkdocs.yml:

mkdocs.yml

plugins:
- mkdocstrings:
    default_handler: python

Injecting documentation¤

With the Python handler installed and configured as default handler, you can inject documentation for a module, class, function, or any other Python object with mkdocstrings' autodoc syntax, in your Markdown pages:

::: path.to.object

If another handler was defined as default handler, you can explicitely ask for the Python handler to be used when injecting documentation with the handler option:

::: path.to.object
    handler: python

Configuration¤

When installed, the Python handler becomes the default mkdocstrings handler. You can configure it in mkdocs.yml:

mkdocs.yml

plugins:
- mkdocstrings:
    handlers:
      python:
        ...  # the Python handler configuration

Global-only options¤

Some options are global only, and go directly under the handler's name.

`inventories`¤

This option is used to load Sphinx-compatible objects inventories from other documentation sites. For example, you can load the standard library objects inventory like this:

mkdocs.yml

plugins:
- mkdocstrings:
    handlers:
      python:
        inventories:
        - https://docs.python.org/3/objects.inv

When loading an inventory, you enable automatic cross-references to other documentation sites like the standard library docs or any third-party package docs. Typically, you want to load the inventories of your project's dependencies, at least those that are used in the public API.

See mkdocstrings' documentation on inventories for more details.

Additionally, the Python handler accepts a domains option in the inventory options, which allows to select the inventory domains to load. By default the Python handler only selects the py domain (for Python objects). You might find useful to also enable the std domain:

mkdocs.yml

plugins:
- mkdocstrings:
    handlers:
      python:
        inventories:
        - url: https://docs.python-requests.org/en/master/objects.inv
          domains: [std, py]

`load_external_modules`¤

This option allows resolving aliases (imports) to any external module. Modules are considered external when they are not part of the package your are injecting documentation for. Setting this option to True will tell the handler to resolve aliases recursively when they are made public through the __all__ variable. By default, the handler will only resolve aliases when they point at a private sibling of the source package, for example aliases going from ast to _ast. Set load_external_modules to False to prevent even that.

Use with caution

This can load a lot of modules through Griffe, slowing down your build or triggering errors that Griffe does not yet handle. We recommend using the preload_modules option instead, which acts as an include-list rather than as include-all.

Example:

mkdocs.yml

plugins:
- mkdocstrings:
    handlers:
      python:
        load_external_modules: true

`locale`¤

Deprecated. Use mkdocstrings' own locale setting.

~~The locale to use when translating template strings.~~

`paths`¤

This option is used to provide filesystem paths in which to search for Python modules. Non-absolute paths are computed as relative to MkDocs configuration file. Example:

mkdocs.yml

plugins:
- mkdocstrings:
    handlers:
      python:
        paths: [src]  # search packages in the src folder

More details at Finding modules.

Global/local options¤

The other options can be used both globally and locally, under the options key. For example, globally:

mkdocs.yml

plugins:
- mkdocstrings:
    handlers:
      python:
        options:
          do_something: true

...and locally, overriding the global configuration:

docs/some_page.md

::: package.module.class
    options:
      do_something: false

These options affect how the documentation is collected from sources and rendered. See the following tables summarizing the options, and get more details for each option in the following pages:

General options: various options that do not fit in the other categories
Headings options: options related to headings and the table of contents (or sidebar, depending on the theme used)
Members options: options related to filtering or ordering members in the generated documentation
Docstrings options: options related to docstrings (parsing and rendering)
Signature options: options related to signatures and type annotations

Finding modules¤

There are multiple ways to tell the handler where to find your packages/modules.

The recommended method is to use the paths option, as it's the only one that works with the -f option of MkDocs, allowing to build the documentation from any location on the file system. Indeed, the paths provided with the paths option are computed as relative to the configuration file (mkdocs.yml), so that the current working directory has no impact on the build process: you can build the docs from any location on your filesystem.

Using the `paths` option¤

This is the recommended method.

mkdocs.yml in root, package in root

📁 root/
├──  mkdocs.yml
└── 📁 package/

mkdocs.yml

plugins:
- mkdocstrings:
    handlers:
      python:
        paths: [.]  # actually not needed, default

mkdocs.yml in root, package in subfolder

📁 root/
├──  mkdocs.yml
└── 📁 src/
    └── 📁 package/

mkdocs.yml

plugins:
- mkdocstrings:
    handlers:
      python:
        paths: [src]

mkdocs.yml in subfolder, package in root

📁 root/
├── 📁 docs/
│   └──  mkdocs.yml
└── 📁 package/

mkdocs.yml

plugins:
- mkdocstrings:
    handlers:
      python:
        paths: [..]

mkdocs.yml in subfolder, package in subfolder

📁 root/
├── 📁 docs/
│   └──  mkdocs.yml
└── 📁 src/
    └── 📁 package/

mkdocs.yml

plugins:
- mkdocstrings:
    handlers:
      python:
        paths: [../src]

Except for case 1, which is supported by default, we strongly recommend setting the path to your packages using this option, even if it works without it (for example because your project manager automatically adds src to PYTHONPATH), to make sure anyone can build your docs from any location on their filesystem.

Using the PYTHONPATH environment variable¤

This method has limitations.

This method might work for you, with your current setup, but not for others trying your build your docs with their own setup/environment. We recommend using the paths method instead.

You can take advantage of the usual Python loading mechanisms. In Bash and other shells, you can run your command like this (note the prepended PYTHONPATH=...):

mkdocs.yml in root, package in root

📁 root/
├──  mkdocs.yml
└── 📁 package/

PYTHONPATH=. mkdocs build  # actually not needed, default

mkdocs.yml in root, package in subfolder

📁 root/
├──  mkdocs.yml
└── 📁 src/
    └── 📁 package/

PYTHONPATH=src mkdocs build

mkdocs.yml in subfolder, package in root

📁 root/
├── 📁 docs/
│   └──  mkdocs.yml
└── 📁 package/

PYTHONPATH=. mkdocs build -f docs/mkdocs.yml

mkdocs.yml in subfolder, package in subfolder

📁 root/
├── 📁 docs/
│   └──  mkdocs.yml
└── 📁 src/
    └── 📁 package/

PYTHONPATH=src mkdocs build -f docs/mkdocs.yml

Installing your package in the current Python environment¤

This method has limitations.

This method might work for you, with your current setup, but not for others trying your build your docs with their own setup/environment. We recommend using the paths method instead.

Install your package in the current environment, and run MkDocs:

pipPDMPoetry

. venv/bin/activate
pip install -e .
mkdocs build

pdm install
pdm run mkdocs build

poetry install
poetry run mkdocs build

Recommended settings¤

If you're in a hurry, here is the configuration we recommend for the Python handler.

- mkdocstrings:
    handlers:
      python:

        # Where to find your sources, see "Finding modules".
        paths: [src]

        # Load object inventories to enable cross-references to other projects.
        inventories:
        - https://docs.python.org/3/objects.inv
        # Also load inventories of your dependencies, generally served at
        # https://docs-url-for-your-dependency/objects.inv.

        options:

          # DOCSTRINGS -------------------------------------------------------------
          docstring_options:
            # Discard first line of `__init__` method docstrings,
            # useful when merging such docstrings into their parent class'.
            ignore_init_summary: true

          # Tables are generally too large, lists will fix this.
          docstring_section_style: list

          # CROSS-REFERENCES -------------------------------------------------------
          # Enable relative crossrefs and scoped crossrefs, see Docstrings options.
          relative_crossrefs: true  # Sponsors only!
          scoped_crossrefs: true  # Sponsors only!

          # Enable cross-references in signatures.
          signature_crossrefs: true

          # Unwrap actual types from `Annotated` type annotations.
          unwrap_annotated: true

          # MEMBERS ----------------------------------------------------------------
          # Only render pulic symbols.
          filters: public  # Sponsors only!
          # Comment the option otherwise to get the default filters.

          # Show class inherited members.
          inherited_members: true

          # Render auto-generated summaries of attributes, functions, etc.
          # at the start of each symbol's documentation.
          summary: true

          # HEADINGS ---------------------------------------------------------------
          # For auto-generated pages, one module per page,
          # make the module heading be the H1 heading of the page.
          heading_level: 1

          # Render headings for parameters, making them linkable.
          parameter_headings: true

          # Render headings for type parameters too.
          type_parameter_headings: true

          # Always show the heading for the symbol you render with `::: id`.
          show_root_heading: true

          # Only show the name of the symbols you inject render `::: id`.
          show_root_full_path: false

          # Show the type of symbol (class, function, etc.) in the heading.
          show_symbol_type_heading: true

          # Show the type of symbol (class, function, etc.) in the table of contents.
          show_symbol_type_toc: true

          # SIGNATURES -------------------------------------------------------------
          # Format code to 80 + 10% margin (Black and Ruff defaults)
          # in signatures and attribute value code blocks.
          # Needs Black/Ruff installed.
          line_length: 88

          # Merge signature and docstring of `__init__` methods
          # into their parent class signature and docstring.
          merge_init_into_class: true

          # Render signatures and attribute values in a separate code block,
          # below the symbol heading.
          separate_signature: true

          # Show type annotations in signatures.
          show_signature_annotations: true

          # Show type parameters in signatures.
          show_signature_type_parameters: true

          # OTHER ------------------------------------------------------------------
          # Show backlinks to other documentation sections within each symbol.
          backlinks: tree  # Sponsors only!

          # Show base classes OR inheritance diagram.
          show_bases: false
          show_inheritance_diagram: true  # Sponsors only!

Usage¤

Installation¤

Injecting documentation¤

Configuration¤

Global-only options¤

inventories¤

load_external_modules¤

~~locale~~¤

paths¤

Global/local options¤

Finding modules¤

Using the paths option¤

Using the PYTHONPATH environment variable¤

Installing your package in the current Python environment¤

Recommended settings¤

Feedback

`inventories`¤

`load_external_modules`¤

`locale`¤

`paths`¤

Using the `paths` option¤