Use sphinx.ext.autosummary to create better index for API docs #653
Labels
category: enhancement
improvements of code or code behavior
help wanted: good first issue
request for community contributions that are good for new contributors
priority: low
alternative solution already working and/or relevant to only specific user(s)
topic: docs
Issues related to documentation
Milestone
Currently the the index for the API docs is in part defined manually and is not easy to navigate (see https://github.com/hdmf-dev/hdmf/blob/dev/docs/source/api_docs.rst and https://hdmf.readthedocs.io/en/stable/api_docs.html) It would be useful to update the docs to use the sphinx extension
sphinx.ext.autosummary
for this. See:Addressing this issue may also require adding missing docstrings for python modules to further enhance the utility of the API docs.
Checklist
The text was updated successfully, but these errors were encountered: