Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Combine apidoc and autosummary #13414

Open
jxrossel opened this issue Mar 5, 2025 · 0 comments
Open

Combine apidoc and autosummary #13414

jxrossel opened this issue Mar 5, 2025 · 0 comments
Labels
type:proposal a feature suggestion

Comments

@jxrossel
Copy link

jxrossel commented Mar 5, 2025

problem

The autosummary extension (https://www.sphinx-doc.org/en/master/usage/extensions/autosummary.html) provides nice summary tables, but no documentation content by default (the templates must be hacked for that: #7912). The apidoc extension (https://www.sphinx-doc.org/en/master/usage/extensions/apidoc.html) provides recursive api file generation, but no summary tables.

solution
Would it be possible to extend the apidoc extension to optionally include summary tables in the generated files? That way, we could have a single full-features approach to automatically document api's with minimal configuration

alternatives
Custom templates for the autosummary extensions, with their potential failings (see #7912)

@jxrossel jxrossel added the type:proposal a feature suggestion label Mar 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:proposal a feature suggestion
Projects
None yet
Development

No branches or pull requests

1 participant