Fix API reference page so all functions render - #502
Open
jjacobson95 wants to merge 1 commit into
Open
jjacobson95 wants to merge 1 commit into
jjacobson95 wants to merge 1 commit into
Conversation
autodoc_typehints must be a string, not a list; the list value made Sphinx's typehints handler raise on the first documented object, which silently truncated the API Reference to only the download function. Also correct the stats function name casing in APIreference.rst (plot_2d_respones_metric) so it is picked up by autodoc.
This branch has not been deployed
This file contains hidden or 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
1 participant
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.
Documentation Update
#2Merge this second.
The API Reference page only displayed the
downloadfunction; every other function was missing.Root cause:
autodoc_typehintsindocs/source/conf.pywas set to a list (["none"]) instead of a string. That made Sphinx's typehints handler raise on the first documented object, silently truncating the rest of the page. A second issue:APIreference.rstlistedplot_2D_respones_metricwith the wrong casing, so that function was never picked up.Changes:
autodoc_typehints = "none"(string, as Sphinx requires)plot_2d_respones_metricinAPIreference.rstVerified via the docs workflow: the build succeeds (it was failing on main) and the rendered API page now lists all Dataset/loader/stats functions.
Closes #475