Skip to main content

Extract API documentation from source code and docstrings. For the python API extension for FumaDocs.

Project description

Fumadocs-autodoc

Generate serialized documentation for your Python projects for use with Fumadocs.

Usage

Install fumadocs-autodoc:

pip install fumadocs-autodoc

Then run the fumadocs-autodoc command with the path to your Python project:

fumadocs-autodoc name-of-package --dir path/to/output/dir

Dependencies

  • griffe

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

fumadocs_autodoc-0.0.1.tar.gz (4.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

fumadocs_autodoc-0.0.1-py3-none-any.whl (7.4 kB view details)

Uploaded Python 3

File details

Details for the file fumadocs_autodoc-0.0.1.tar.gz.

File metadata

  • Download URL: fumadocs_autodoc-0.0.1.tar.gz
  • Upload date:
  • Size: 4.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for fumadocs_autodoc-0.0.1.tar.gz
Algorithm Hash digest
SHA256 30456bf359ed480c4631bc10703e5c768ee7f8256a36ecd0baef691000b446b1
MD5 3cdb62fc899fe98b44f03fddbd745ea9
BLAKE2b-256 f2afd14fb03be580133f90c63b06eb7d4ea16c8097a7cbc4d67139809dc2f55a

See more details on using hashes here.

File details

Details for the file fumadocs_autodoc-0.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for fumadocs_autodoc-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9dada0e2eea737edac719d8c19fdf479ad0863cf827bd223cac9d0b55f54fad6
MD5 cb564fc04e010d81887bcb5e59c0d194
BLAKE2b-256 8f91e016e65112361feb33244bc082ded7706a93a4ae2bf9bb9fc855251f2a04

See more details on using hashes here.

Supported by

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