From 1c440c6d92cada6206221aa51ae901dcc6f1efe1 Mon Sep 17 00:00:00 2001 From: Jeremy Date: Mon, 28 Sep 2026 10:08:27 -0700 Subject: [PATCH] Fix API reference rendering so all functions and their arguments appear 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. --- docs/source/APIreference.rst | 2 +- docs/source/conf.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/APIreference.rst b/docs/source/APIreference.rst index b510c9a3..0d245c3f 100644 --- a/docs/source/APIreference.rst +++ b/docs/source/APIreference.rst @@ -36,6 +36,6 @@ Dataset Object :show-inheritance: .. automodule:: coderdata.utils.stats - :members: summarize_response_metric, plot_response_metric, plot_2D_respones_metric + :members: summarize_response_metric, plot_response_metric, plot_2d_respones_metric :no-undoc-members: :show-inheritance: diff --git a/docs/source/conf.py b/docs/source/conf.py index bd033acd..b9d1073c 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -49,7 +49,7 @@ # docstrings changes autosummary_generate = True -autodoc_typehints = ["none"] +autodoc_typehints = "none" # -- Options for HTML output -------------------------------------------------