Docs update: Fix API Reference page #198
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fix the sidebar TOC
The sidebar TOC had a bug. This comes from sphinx-book-theme, which uses the pydata-sphinx-theme. I filed a bug report in
pydata/pydata-sphinx-theme#1724
but that was closed as the root cause is likely in the Bootstrap scroll spy (upstream issue). The bug causes the right side sidebar TOC to not show fully on the API reference page, "active"
<ul>or<li>elements are shown, and this activation does not work at all on the API Reference page.This could have probably been circumvented in a more elegant way but I decided to take a shortcut and
The logic is in the wakepy.js. This can be removed if the issue is fixed in pydata-sphinx-theme or in sphinx-book-theme.
Remove NamedTuple noise
The NamedTuples caused noise in the API Reference page. Namely, there was extra "Alias for field number X" (X is a number of the field) items in the docs, for everything that is subclass of NamedTuple.
This fix uses temporarily numpydoc 1.7.0rc0.dev0 directly from
https://github.com/numpy/numpydoc.git@46f532a824639a97479039fc122533915cdfa10f
When numpydoc 1.7.0 is released, can update pyproject.toml to use that.