Various improvements to the configuration for LSST Stack-based documentation projects (documenteer.sphinxconf.stackconf):
Replaced the third-party astropy_helpers package with the numpydoc and sphinx-automodapi packages. This helps reduce the number of extraneous dependencies needed for Stack documentation.
Special methods (dunder methods) are now included in API documentation (autodoc_default_flags includes special-members).
autoclass_content is now "class", fitting the LSST DM standards for writing class docstrings, and not filling out __init__ docstrings.
Removed h5py from intersphinx since it was never needed.
Removed the viewcode extension since that won't scale well with the LSST codebase. Ultimately we want to link to source on GitHub.
Other internal cleanups for documenteer.sphinxconf.stackconf.
Various improvements to the configuration for LSST Stack-based documentation projects (
documenteer.sphinxconf.stackconf):Replaced the third-party
astropy_helperspackage with the numpydoc andsphinx-automodapipackages. This helps reduce the number of extraneous dependencies needed for Stack documentation.Special methods (dunder methods) are now included in API documentation (
autodoc_default_flagsincludesspecial-members).autoclass_contentis now"class", fitting the LSST DM standards for writing class docstrings, and not filling out__init__docstrings.Removed h5py from intersphinx since it was never needed.
Removed the viewcode extension since that won't scale well with the LSST codebase. Ultimately we want to link to source on GitHub.
Other internal cleanups for
documenteer.sphinxconf.stackconf.Fixes #26 and #27