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.1.tar.gz (2.7 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.1-py3-none-any.whl (3.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx_autoindex-0.1.1.tar.gz
  • Upload date:
  • Size: 2.7 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.1.tar.gz
Algorithm Hash digest
SHA256 8370e2c01299774618a76bb14643914187e19ab15d1b12251fa8d419450eedb8
MD5 190bc859db92f526e1c947022f972fe4
BLAKE2b-256 50044114fe086e85220ddf9b3f1ce92176c377b9949251e287643cef3302c932

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sphinx_autoindex-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c91bf00cec52c45adaf211f71aab3f53dff1722c4d23054309736540440d7a08
MD5 a63b71946c3a9456f3d0ad6012e6f191
BLAKE2b-256 8277084ef6c5bc9909d85bf3d1025da9e68b316fd1052c865f99b0ae993a5196

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