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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file mkdocs_py_ref_gen-0.1.1.tar.gz.

File metadata

  • Download URL: mkdocs_py_ref_gen-0.1.1.tar.gz
  • Upload date:
  • Size: 5.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.9.10 Darwin/24.0.0

File hashes

Hashes for mkdocs_py_ref_gen-0.1.1.tar.gz
Algorithm Hash digest
SHA256 61391308df86d63a1dbf9a5bbf58d9fb183ea56776d7fac57aee4a255dfc9185
MD5 999c28482e25291afb0ff66242d78946
BLAKE2b-256 ecfc2acbfeb9b3334e922875142105aede3225305101cff63a8045aa586a64c2

See more details on using hashes here.

File details

Details for the file mkdocs_py_ref_gen-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for mkdocs_py_ref_gen-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 af1f1a10f3dfe5d7bf9ef325d62b9557b6d9ffabd1f021da53658f170342bcfc
MD5 e61e261164a5242eb0cb41e7d5ec2d8a
BLAKE2b-256 29fae5ad3ba17a01b7b94010af0733e3cc1f6cedd48518f60844e84d5bc02295

See more details on using hashes here.

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