Usage - mkdocstrings (original) (raw)

Autodoc syntax¤

mkdocstrings works by processing special expressions in your Markdown files.

The syntax is as follows:

::: identifier YAML block

Resources on YAML.

YAML can sometimes be a bit tricky, particularly on indentation. Here are some resources that other users found useful to better understand YAML's peculiarities.

The identifier is a string identifying the object you want to document. The format of an identifier can vary from one handler to another. For example, the Python handler expects the full dotted-path to a Python object: my_package.my_module.MyClass.my_method.

The YAML block is optional, and contains some configuration options:

Example with the Python handler

docs/my_page.mdmkdocs.ymlsrc/my_package/my_module.pyResult

`` # Documentation for MyClass

::: my_package.my_module.MyClass handler: python options: members: - method_a - method_b show_root_heading: false show_source: false ``

`nav:

`class MyClass: """Print print print!"""

def method_a(self):
    """Print A!"""
    print("A!")

def method_b(self):
    """Print B!"""
    print("B!")

def method_c(self):
    """Print C!"""
    print("C!")

`

Documentation for MyClass

It is also possible to integrate a mkdocstrings identifier into a Markdown header:

## ::: my_package.my_module.MyClass options: show_source: false

The above is equivalent to:

::: my_package.my_module.MyClass options: show_source: false heading_level: 2

Global options¤

mkdocstrings accepts a few top-level configuration options in mkdocs.yml:

Example

mkdocs.yml

`plugins:

`

The handlers global configuration can then be overridden by local configurations:

docs/some_page.md

::: my_package.my_module.MyClass options: show_source: true

Some handlers accept additional global configuration. Check the documentation for your handler of interest in Handlers.

Cross-references¤

Cross-references are written as Markdown reference-style links:

MarkdownHTML Result

`` With a custom title: [Object 1][full.path.object1]

With the identifier as title: [full.path.object2][] ``

`

With a custom title: Object 1

With the identifier as title: full.path.object2

`

Any item that was inserted using the autodoc syntax (e.g. ::: full.path.object1) is possible to link to by using the same identifier with the cross-reference syntax ([example][full.path.object1]). But the cross-references are also applicable to the items' children that get pulled in.

Finding out the anchor¤

If you're not sure which exact identifier a doc item uses, you can look at its "anchor", which your Web browser will show in the URL bar when clicking an item's entry in the table of contents. If the URL is https://example.com/some/page.html#full.path.object1 then you know that this item is possible to link to with [example][full.path.object1], regardless of the current page.

Cross-references to any Markdown heading¤

Changed in version 0.15.

Linking to any Markdown heading used to be the default, but now opt-in is required.

If you want to link to any Markdown heading, not just _mkdocstrings_-inserted items, please enable the autorefs plugin for MkDocs by adding autorefs to plugins:

mkdocs.yml

`plugins:

Note that you don't need to (pip) install anything more; this plugin is guaranteed to be pulled in with mkdocstrings.

Example

doc1.mddoc2.mdResult HTML for doc2

`## Something else

Please see the [Hello, World!][hello-world] section. `

<p>Please see the <a href="doc1.html#hello-world">Hello, World!</a> section.</p>

Cross-references to a sub-heading in a docstring¤

New in version 0.14.

If you have a Markdown heading inside your docstring, you can also link directly to it. In the example below you see the identifier to be linked is foo.bar--tips, because it's the "Tips" heading that's part of the foo.bar object, joined with "--".

Example

foo.pydoc1.mddoc2.mdHTML result for doc2

`def bar(): """Hello, world!

# Tips

- Stay hydrated.
"""

`

Check out the [tips][foo.bar--tips]

<p>Check out the <a href="doc1.html#foo.bar--tips">tips</a></p>

The above tip about Finding out the anchor also applies the same way here.

You may also notice that such a heading does not get rendered as a <h1> element directly, but rather the level gets shifted to fit the encompassing document structure. If you're curious about the implementation, check out mkdocstrings.HeadingShiftingTreeprocessor and others.

Cross-references to other projects / inventories¤

New in version 0.16.

Python developers coming from Sphinx might know about its intersphinx extension, that allows to cross-reference items between several projects. mkdocstrings has a similar feature.

To reference an item from another project, you must first tell mkdocstrings to load the inventory it provides. Each handler will be responsible of loading inventories specific to its language. For example, the Python handler can load Sphinx-generated inventories (objects.inv).

In the following snippet, we load the inventory provided by installer:

mkdocs.yml

`plugins:

`

Now it is possible to cross-reference installer's items. For example:

MarkdownResult (HTML)Result (displayed)

See [installer.records][] to learn about records.

<p>See <a href="https://installer.readthedocs.io/en/stable/api/records/#module-installer.records">installer.records</a> to learn about records.</p>

You can of course select another version of the inventory, for example:

`plugins:

`

In case the inventory file is not served under the base documentation URL, you can explicitly specify both URLs:

`plugins:

`

Absolute URLs to cross-referenced items will then be based on https://docs.example.com/version/ instead of https://cdn.example.com/version/.

If you need authentication to access the inventory file, you can provide the credentials in the URL, either as username:password:

- url: https://username:password@private.example.com/version/objects.inv

...or with token authentication:

- url: https://token123@private.example.com/version/objects.inv

The credentials can also be specified using environment variables in the form ${ENV_VAR}:

- url: https://${USERNAME}:${PASSWORD}@private.example.com/version/objects.inv

Reciprocally, mkdocstrings also allows to generate an inventory file in the Sphinx format. It will be enabled by default if the Python handler is used, and generated as objects.inv in the final site directory. Other projects will be able to cross-reference items from your project.

To explicitly enable or disable the generation of the inventory file, use the global enable_inventory option:

`plugins: