-
Notifications
You must be signed in to change notification settings - Fork 22
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
docs: Enable drop-downs in the API #1095
Comments
With @rouk1 we looked at this for a bit with our limited knowledge of sphinx/rst. Here are the two ideas we had: Change file structure of the
|
From a quick look at it, the thing I would try 1 is to try to mirror pandas structure:
This may be possible to do it in a single file, but I have to admit I never managed to understand the sphinx toctree and how this relates to the left-hand-side navbar ... Footnotes
|
@glemaitre Maybe you have an idea? The accessor documentation logic makes this harder it seems. I'd be happy to pair on this |
Follow-up of #1077, originally posted by @sylvaincom in #1077 (comment)
Which part of the documentation needs improvement?
API documentation
Describe the problem found in the documentation
The EstimatorReport uses some methods (accessors) that exist only in some cases (whether classification or regression for example). So it's complicated with the Sphinx API. @glemaitre found a
sphinx_autosummary_accessors
Sphinx plug-in that is currently used by skore. Otherwise, Sphinx sees accessors as properties and is not able to build an API. Hence, all accessors exist. However, the list is currently too long:Suggested improvement
As done in Pandas, we should use drop-downs:
Enregistrement.de.l.ecran.2025-01-10.a.15.20.05.mov
Additional context
No response
The text was updated successfully, but these errors were encountered: