search

readthedocs / sphinx-autoapi

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

is it possible to split class method in separated pages ? #403

Closed 12rambau closed 5 months ago

12rambau commented 9 months ago

I have a pretty heavy API to document and it's barely readable if all class methods are stored in the same file, I'm very much interested in the work done in https://github.com/readthedocs/sphinx-autoapi/pull/399.

Would it be possible to reach even smaller level of granularity ?

maybe special case everything is not the way to go and a custom template would be more advisable. Is templating available for autoapi ?

I would like to split my doc like pandas is doing e.g. : https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.size.html

AWhetter commented 5 months ago

This will get implemented as part of #226. Thanks for the additional example of pandas!