Skip to main content

Automatic documentation from docstrings, for mkdocs.

Project description

mkdocstrings

pipeline status coverage report documentation pypi version

Automatic documentation from docstrings, for mkdocs.

This plugin is still in alpha status. Here is how it looks with the mkdocs-material theme for now:

mkdocstrings

Features

  • Works great with Material theme: mkdocstrings was designed to work best with the great Material theme.
  • Support for type annotations: mkdocstrings uses your type annotations to display parameters types or return types.
  • Recursive documentation of Python objects: just write the module dotted-path, and you get the full module docs. No need to ask for each class, function, etc.
  • Support for documented attribute: attributes (variables) followed by a docstring (triple-quoted string) will be recognized by mkdocstrings, in modules, classes and even in __init__ methods.
  • Support for objects properties: mkdocstrings will know if a method is a staticmethod, a classmethod or else, it will also know if a property is read-only or writable, and more! These properties will be displayed next to the object signature.
  • Every object has a TOC entry and a unique permalink: the navigation is greatly improved! Click the anchor next to the object signature to get its permalink, which is its Python dotted-path.
  • Auto-reference other objects: mkdocstrings makes it possible to reference other Python objects from your markdown files, and even from your docstrings, with the classic Markdown syntax: [this object][package.module.object] or directly with [package.module.object][].
  • Google-style sections support in docstrings: mkdocstrings understands Arguments:, Raises: and Returns: sections. It will even keep the section order in the generated docs.
  • Support for source code display: mkdocstrings can add a collapsible div containing the source code of the Python object, directly below its signature, with the right line numbers.
  • Admonition support in docstrings: blocks like Note: or Warning: will be transformed to their admonition equivalent. We do not support nested admonitions in docstrings!
  • Sane defaults: you should be able to just drop the plugin in your configuration and enjoy your auto-generated docs.
  • Configurable: (soon) mkdocstrings is configurable globally, and per autodoc instruction.

To get an example of what is possible, check mkdocstrings' own documentation, generated with itself.

Requirements

mkdocstrings requires Python 3.6 or above.

To install Python 3.6, I recommend using pyenv.
# install pyenv
git clone https://github.com/pyenv/pyenv ~/.pyenv

# setup pyenv (you should also put these three lines in .bashrc or similar)
export PATH="${HOME}/.pyenv/bin:${PATH}"
export PYENV_ROOT="${HOME}/.pyenv"
eval "$(pyenv init -)"

# install Python 3.6
pyenv install 3.6.8

# make it available globally
pyenv global system 3.6.8

Installation

With pip:

python3.6 -m pip install mkdocstrings

Usage

# mkdocs.yml

# designed to work best with material theme
theme:
  name: "material"

plugins:
  - search
  - mkdocstrings

In one of your markdown files:

# Reference

::: my_library.my_module.my_class

You can reference objects from other modules in your docstrings:

def some_function():
    """
    This is my function.

    It references [another function][package.submodule.function].
    It also references another object directly: [package.submodule.SuperClass][].
    """
    pass

Add some style in docs/custom.css:

div.autodoc {
  padding-left: 25px;
  border-left: 4px solid rgba(230, 230, 230);
}

And add it to your configuration:

extra_css:
  - custom.css

Docstrings format

Your docstrings must follow a particular format, otherwise mkdocstrings will throw an exception. This will be improved to be more robust over time.

from typing import Optional

def my_function(param1: int, param2: Optional[str] = None) -> str:
    """
    A short description of this function.

    A longer description of this function.
    You can use more lines.

        This is code block,
        as usual.

    ```python
    s = "This is a Python code block :)"
    ```

    Arguments:
        param1: An integer?
        param2: A string? If you have a long description,
          you can split it on multiple lines.
          Just remember to indent those lines with at least two more spaces.
               They will all be concatenated in one line, so do not try to
             use complex markup here.

    Important:
        Note how we omitted the type hints next to the parameters names.
        Usually you would write something like `param1 (int): ...`,
        but `mkdocstrings` gets the type information from the signature, so it's not needed here.

    Exceptions are written the same.

    Raises:
        OSError: Explain when this error is thrown.
        RuntimeError: Explain as well.
          Multi-line description, etc.

    Let's see the return value section now.
    
    Returns:
        A description of the value that is returned.
        Again multiple lines are allowed. They will also be concatenated to one line,
        so do not use complex markup here.

    Note:
        Other words are supported:
        
        - `Args`, `Arguments`, `Params` and `Parameters` for the parameters.
        - `Raise`, `Raises`, `Except`, and `Exceptions` for exceptions.
        - `Return` or `Returns` for return value.

        They are all case-insensitive, so you can write `RETURNS:` or `params:`.
    """
    return f"{param2}{param1}"

This docstring would be rendered like this (had to take two screenshots, so it's not perfectly aligned):

image image

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for mkdocstrings, version 0.7.0
Filename, size File type Python version Upload date Hashes
Filename, size mkdocstrings-0.7.0-py3-none-any.whl (21.8 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size mkdocstrings-0.7.0.tar.gz (19.7 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page