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

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx_autoindex-0.1.3.tar.gz
  • Upload date:
  • Size: 3.2 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.3.tar.gz
Algorithm Hash digest
SHA256 532a0e95af46ba6ca4bb2511aaa49be27ede01bc0a80de27f6cc0318469c6312
MD5 f8f3077626f9bbc92e7a46be8dea1ae6
BLAKE2b-256 d4090866457f785ebcf56ed9fa6d90e39ea7c2bdf34792f5ae5dfd827531f4aa

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sphinx_autoindex-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 a37188af19358a6b82cfbe7799f06ad1e2224b9bb0417d21ef9633a1d2c281e4
MD5 69a35ed3f2017ae1de1331a1a889729c
BLAKE2b-256 bb35febb4a1b3fbae627a85c07bcd5a0441b3dae2897642d923ccbdad29b374b

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