Metadata-Version: 2.4
Name: sphinx_autoindex
Version: 0.1.4
Summary: Sphinx extension to automatically index the source code for autodoc
Author: Mickael Descamps
Project-URL: Homepage, https://mickaeldescamps.github.io/sphinx-autoindex
Project-URL: Repository, https://github.com/MickaelDescamps/sphinx-autoindex
Project-URL: Issues, https://github.com/MickaelDescamps/sphinx-autoindex/issues
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: sphinx
Provides-Extra: docs
Requires-Dist: sphinx; extra == "docs"
Requires-Dist: sphinx-autodoc-typehints; extra == "docs"
Requires-Dist: sphinx-autoindex; extra == "docs"
Requires-Dist: sphinx-copybutton>=0.5.2; extra == "docs"
Requires-Dist: sphinx-prompt>=1.9.0; extra == "docs"
Requires-Dist: sphinx-rtd-theme>=3.0.2; extra == "docs"
Requires-Dist: sphinxemoji>=0.3.1; extra == "docs"
Requires-Dist: toml>=0.10.2; extra == "docs"
Requires-Dist: myst-parser>=4.0.1; extra == "docs"

# 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](https://mickaeldescamps.github.io/sphinx-autoindex/api/extension.html)

## Report a Bug, have an Idea ? 
Do not hesitate to report bug or publish your idea to improve this extension with an issue.
