-
Notifications
You must be signed in to change notification settings - Fork 26
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
Setup sphinx.ext.autosummary for the API-docs #654
base: dev
Are you sure you want to change the base?
Conversation
@rly if you get a chance, can you build the docs for this PR and see how the new summary and navigation for the API docs look. This PR is basically ready. There is one remaining issue in that I am getting a lot of warnings while building the docs of the form:
I'm not sure yet how to fix these. The docs seem to work fine but it would be best to fix these before merging. Any idea how to best fix these? |
This looks like a good start to me. I was able to remove the warnings by editing the autosummary template and adding |
@rly what do you think are the main open items we should resolve before merging this? Its fine to leave this PR open for a future docathon but it would be useful to mark what areas we would like to further improve on this to allow folks to chip in. |
|
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## dev #654 +/- ##
==========================================
- Coverage 88.70% 87.37% -1.33%
==========================================
Files 45 44 -1
Lines 9745 8730 -1015
Branches 2767 2007 -760
==========================================
- Hits 8644 7628 -1016
- Misses 779 787 +8
+ Partials 322 315 -7 ☔ View full report in Codecov by Sentry. |
Motivation
Evaluate the use of
sphinx.ext.autosummary
to enhance the navigation of the API docs. See also:#653
Checklist
flake8
from the source directory.