Skip to main content

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

Project description

mkdocs-py-ref-gen

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

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

pip install mkdocs-py-ref-gen

usage

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

Click me for full documention

Project details


Download files

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

Source Distribution

mkdocs_py_ref_gen-0.1.1.tar.gz (5.3 kB view hashes)

Uploaded Source

Built Distribution

mkdocs_py_ref_gen-0.1.1-py3-none-any.whl (6.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page