readthedocs / sphinx-autoapi

A new approach to API documentation in Sphinx.
https://sphinx-autoapi.readthedocs.io/
MIT License
415 stars 126 forks source link

Document `autoapisummary` #377

Open astrojuanlu opened 1 year ago

astrojuanlu commented 1 year ago

I'm trying to move a docs project from sphinx.autosummary to sphinx-autoapi, so I'm trying to understand whether I can translate the .. autosummary directives with .. autoapisummary. However, the latter is not documented. It's defined here:

https://github.com/readthedocs/sphinx-autoapi/blob/85739d513e2dceba4e9c9190aead68b7d9f96870/autoapi/directives.py#L12-L13