Skip to main content

Sphinx extension to automatically index the source code for autodoc

Project description

Sphinx autoindex extension

This Sphinx extension has for purpose to provide auto indexer extension who works like autoapi before generation the source just before to build but use autodoc to document your code and is compatible with pydantic extension, attrs and other extension that depend from autodoc usage.

[!WARNING] This package is not ready for production environment. If you see bugs or have idea to improve it let an issue Thanks

Documentation

You can see how to use this extension here Documentation

Report a Bug, have an Idea ?

Do not hesitate to report bug or publish your idea to improve this extension with an issue.

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

sphinx_autoindex-0.1.5.tar.gz (4.6 kB view details)

Uploaded Source

Built Distribution

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

sphinx_autoindex-0.1.5-py3-none-any.whl (5.3 kB view details)

Uploaded Python 3

File details

Details for the file sphinx_autoindex-0.1.5.tar.gz.

File metadata

  • Download URL: sphinx_autoindex-0.1.5.tar.gz
  • Upload date:
  • Size: 4.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for sphinx_autoindex-0.1.5.tar.gz
Algorithm Hash digest
SHA256 72414feb3890bab457e807aef5d4eb0acd72bbedc57cde378eca494d80fea65c
MD5 c14abf0b7447640d20611cb5c6097ed9
BLAKE2b-256 384814a8ffb6cef3a4bfe8783bdda33bafedc697e5ccb36ef81b5ea87fc797c5

See more details on using hashes here.

File details

Details for the file sphinx_autoindex-0.1.5-py3-none-any.whl.

File metadata

File hashes

Hashes for sphinx_autoindex-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 061bf7cb8a2f3f1c9a8f3309d09bf2e7755ca97f3617252720e2d1e66537e1b5
MD5 8af52bd03941a26865574330b5d26610
BLAKE2b-256 285ae5e0db66603553ec0451df5e4b007989ec311d9f8538a0392cbb8b9364ec

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