astropy / astropy/sphinx-automodapi
Can this package be replaced by something else already in Sphinx?
- Dominant language
- Python
- Stars
- 67
- Forks
- 48
- Avg merge
- 11h 52m
- Merged PRs (30d)
- 1
Description
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
Contributor guide
No contributing guide indexed for this repository
Research direction
Compare this package's documented behavior with Sphinx's autosummary, sphinx-autogen, and sphinx-apidoc features, starting from the linked Sphinx documentation. Determine which capabilities are covered and which are missing; done means recording whether the package can be replaced and how this relates to superseding issue #146.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100