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

Can this package be replaced by something else already in Sphinx? #147

Open
pllim opened this issue Apr 7, 2022 · 1 comment
Open

Can this package be replaced by something else already in Sphinx? #147

pllim opened this issue Apr 7, 2022 · 1 comment
Labels

Comments

@pllim
Copy link
Member

pllim commented Apr 7, 2022

When this package was written, Sphinx was pretty young. Perhaps it has a built-in feature that can replace this package now; maybe https://www.sphinx-doc.org/en/master/usage/extensions/autosummary.html#sphinx-autogen-generate-autodoc-stub-pages ? Or is this not possible because what Sphinx has is not completely automated?

Simon, "... they have https://www.sphinx-doc.org/en/master/man/sphinx-autogen.html and https://www.sphinx-doc.org/en/master/man/sphinx-apidoc.html, but it's not clear to me what it covers and what is missing."

This would supersede #146

@HealthyPear
Copy link

Personally, after dealing with #73 I tried to revert to using native sphinx extensions like autodoc, autosummary, and the 2 CLIs mentioned here, but it's really not the same thing...they do what they say but the overhead is a lot, and the amount of code to maintain increases.

Apart from the great annoyance of #73 this package never let me down, really.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants