Skip to content

mkdocs-py-ref-gen

mkdocs plugin to generate reference mdfiles and summary of python package(s)

It's a wrapper plugin built using mkdocs-gen-file and mkdocs-literate-nav

pip install mkdocs-py-ref-gen

The plugin requires mkdocstrings[python]

pip install 'mkdocstrings[python]'

usage

plugin config
plugins:
  - py-ref-gen:
      modules:
        - name: "my_module"