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

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx_autoindex-0.1.2.tar.gz
  • Upload date:
  • Size: 3.1 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.2.tar.gz
Algorithm Hash digest
SHA256 5a21112ff53c6551b00cf8a23705328e74b96193dbe35347bf8f3e161031e03b
MD5 e5b255ba0f6bb5de97cd604cfb7b52f8
BLAKE2b-256 18d88f331797c98fcadbc081aa994feb6d8948139048f6329c564b0a7eba861f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sphinx_autoindex-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 7b3ad17ebd940bb779a5e1c8c340fec08303e6533d03d507961bff0d2b33880e
MD5 52af2c1f74132a89b23f54111056c98a
BLAKE2b-256 03e88b7d1ceebce5f54789b912b43a2609d93b31c25fabfd966fcfb04b3b2075

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