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.4.tar.gz (4.4 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.4-py3-none-any.whl (5.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx_autoindex-0.1.4.tar.gz
  • Upload date:
  • Size: 4.4 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.4.tar.gz
Algorithm Hash digest
SHA256 ea03ae139c851a367da32f3298fccc0a06b8bebeb91da1fd93b21546a2851a19
MD5 e868a282af8bc87b52122a880b866d74
BLAKE2b-256 0ab9a0d2f9696e4610842b52a3dc7683a5e6c0fb7aeefe2dd4e24a3ce13a70c7

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for sphinx_autoindex-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 6fca46fdd1c075a9eca020f65086d925a4c0918d23179dde47a6c00c55f869c7
MD5 b30453d5911ece714c9608bf90c8b986
BLAKE2b-256 03cdb435f3a35686c973a740f493897e3943104eca6f0a9419fa6ffb045475f4

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