mkdocstrings-python-generator 1.0.0rc1

Autogenerates a project's mkdocs reference documentation via mkdocstrings-python

mkdocstrings-python-generator

mkdocstrings-python-generator is a mkdocs plugin for generating markdown pages automatically from python source code.

It is intended to fill a gap which is currently left to each user of mkdoctstings-python. Namely: generating markdown files for each python file.

Note despite the name there is no affiliation between mkdocstrings and mkdocstrings-python-generator. Please try to determine which plugin is to blame before posting issues here or there.

Features

Its advantages over the mkdocstrings-python recipe are:

• ✅ Easier to use (no writing code for yourself)
• ✅ Well formatted nav out of the box. Package names with underscores are not title case 📦
• ✅ Compatibility with both explicit nav defined in mkdocs.yaml and implicit nav with no definition in mkdocs.yaml
• ✅ Supports __init__.py files as section indexes if supported by the theme.
• ✅ Edit URI compatible with both edit_uri and edit_uri_template

Minimal Example

See Configuration for more detail

# Configure mkdocstrings-python
- mkdocstrings:
    handlers:
      python:
        options:
          show_submodules: false

# Configure mkdocstrings-python-generator
- mkdocstrings-python-generator:
    source_dirs:
      # Path to your source directory relative to mkdocs.yaml directory.
      - base: src/