8000 DOC Introduce dropdowns in the User Guide · Issue #26617 · scikit-learn/scikit-learn · GitHub
[go: up one dir, main page]
Skip to content

DOC Introduce dropdowns in the User Guide #26617

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.

Sign up for GitHub

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

Jump to bottom
Closed
53 of 54 tasks
ArturoAmorQ opened this issue Jun 19, 2023 · 41 comments · Fixed by #27631
Closed
53 of 54 tasks

DOC Introduce dropdowns in the User Guide #26617

ArturoAmorQ opened this issue Jun 19, 2023 · 41 comments · Fixed by #27631
Labels
Documentation good first issue Easy with clear instructions to resolve Meta-issue General issue associated to an identified list of tasks

Comments

@ArturoAmorQ
Copy link
Member
ArturoAmorQ commented Jun 19, 2023 •
edited by Charlie-XIAO
Loading

Describe the issue linked to the documentation

Dropdowns are implemented in #26625. They can help users avoid scrolling trough large pages and can quickly get them access to the content they are interested in.

Suggest a potential alternative/fix

Use dropdowns to hide:

  • low hierarchy sections such as References, Properties, etc. See for instance the subsections in 3.3.2.16 Detection error tradeoff (DET);
  • in-depth mathematical details;
  • narrative that is too use-case specific;
  • narrative that may only interest users that want to go beyond the pragmatics of a given tool.

Additionally:

  • Do not use dropdowns for the low level section Examples, as it should stay visible to all users. Make sure that the Examples section comes right after the main discussion with the least possible folded section in-between.
  • Be aware that dropdowns break cross-references. If that makes sense, hide the reference along with the text mentioning it. Else, do not use dropdown.

For more information see Contributing to documentation, notably the "Guidelines for writing the User Guide and other reStructuredText documents" dropdown.

This is the list of sub-modules to be addressed:

Contributors willing to address this issue, please offer one of the above sub-modules per pull request. Remember also to mention on which module you are working on.

Thanks for your help!
@ArturoAmorQ ArturoAmorQ added Documentation Needs Triage Issue requires triage labels Jun 19, 2023
@GaelVaroquaux
Copy link
Member

+1000. Thanks a lot for suggesting this, this is super useful!

@ArturoAmorQ ArturoAmorQ mentioned this issue Jun 19, 2023
Merged
@ArturoAmorQ ArturoAmorQ added good first issue Easy with clear instructions to resolve dependencies Pull requests that update a dependency file and removed Needs Triage Issue requires triage dependencies Pull requests that update a dependency file labels Jun 19, 2023
This was referenced Jun 19, 2023
Merged
Merged
Merged
Closed
@Tech-Netiums Tech-Netiums mentioned this issue Jun 21, 2023
Closed
@Shreesha3112
Copy link
Contributor
Shreesha3112 commented Jun 22, 2023 •
edited
Loading

Working on 1.10. Decision Trees

@greyisbetter greyisbetter mentioned this issue Jun 22, 2023
Merged
@Tech-Netiums
Copy link
Contributor

Working on 1.7 Gaussian Processes

@greyisbetter greyisbetter mentioned this issue Jun 23, 2023
Closed
@punndcoder28
Copy link
Contributor
punndcoder28 commented Jun 24, 2023 •
edited
Loading

Working on 7.2 Real world datasets, 2.1 Gaussian mixtures, 2.2 Manifold Learning

How do I make the images on the doc pages load while building it locally? I am only able to see the image path and not the actual image on the webpage

This was referenced Jun 24, 2023
Merged
Merged
@rprkh
Copy link
Contributor
rprkh commented Jun 26, 2023

Working on 7.1. Toy datasets

@Shreesha3112 Shreesha3112 mentioned this issue Jun 26, 2023
Merged
@lucyleeow
Copy link
Member
lucyleeow commented Jun 27, 2023 •
edited
Loading

You don't seem to be able to get a permalink to headers with these new dropdowns. Would it be possible to add this?
cc @ArturoAmorQ and @glemaitre

Edit: to expand, you used to be able to get a link to a header by clicking next to it (mouse was next to the header in the screenshot):

image

But this will not work with the new drop downs

@rprkh rprkh mentioned this issue Jun 27, 2023
Merged
@glemaitre
Copy link
Member

I might think of two solutions (but I have poor understanding in HTML/CSS):

  • Would need to inject an id="xxx" in the <details> tag. I don't see any straightforward way to do that.
  • We could use a workaround and require to add tag with the id, i.e. <span id="xxx">Summary</span> that will be inject between the <summary> tag.

Then, in terms of HTML, we can refer to this section using #xxx. What I am not sure about is if the :ref: directive from sphinx can be used or we should use a pure HTML tag then.

@GaelVaroquaux
Copy link
Member
GaelVaroquaux commented Jun 27, 2023 via email

@greyisbetter
Copy link
Contributor

Maybe I don't understand the main issue, but if we are trying to resolve permalinks with Sphinx instead of HTML then this can be done:

.. _my-header-label:

My Header
=========

This is the content of the header.

You can refer to this header using the :ref:`My Header <my-header-label>`.

@punndcoder28 punndcoder28 mentioned this issue Jun 28, 2023
Merged
@tongyu0924
Copy link
Contributor

Working on 2.8. Density Estimation

@tongyu0924 tongyu0924 mentioned this issue Jul 3, 2023
Merged
@subhan97ahmed subhan97ahmed mentioned this issue Sep 7, 2023
Closed
@anamfatima1304
Copy link
Contributor

Working on 1.7. Gaussian Processes

@anamfatima1304 anamfatima1304 mentioned this issue Sep 18, 2023
Merged
@kots14
Copy link
Contributor
kots14 8000 commented Oct 5, 2023

Working on 2.5. Decomposing signals in components (matrix factorization problems)

kots14 added a commit to kots14/scikit-learn that referenced this issue Oct 8, 2023
@kots14
Update decomposition.rst
d2468c0 
Update decomposition.rst with drop downs scikit-learn#26617
@kots14 kots14 mentioned this issue Oct 8, 2023
Merged
@KartikeyBartwal
Copy link
KartikeyBartwal commented Oct 14, 2023 •
edited
Loading

starting to work on 1.17. Neural network models (supervised) and 1.8. Cross decomposition

@KartikeyBartwal KartikeyBartwal mentioned this issue Oct 18, 2023
Closed
@jeromedockes
Copy link
Contributor
jeromedockes commented Oct 20, 2023 •
edited
Loading

I'll work on 3.2. Tuning the hyper-parameters of an estimator in #27631

@jeromedockes jeromedockes mentioned this issue Oct 20, 2023
Merged
@kots14
Copy link
Contributor
kots14 commented Nov 5, 2023

Awaiting review on this PR - #27551

@lebaudantoine
Copy link
lebaudantoine commented Dec 6, 2023 •
edited
Loading

May I work on Ensemble methods ? as the PR #27174 was closed

This was referenced Dec 8, 2023
Merged
Merged
Merged
Merged
Merged
Merged
@ArturoAmorQ
Copy link
Member Author

May I work on Ensemble methods ? as the PR #27174 was closed

Looks like somebody already submitted a PR for that, @lebaudantoine. Next time feel free to do the same or just mention "Working on ...."

@Jiya126
Copy link
Jiya126 commented Dec 13, 2023

Are there any tasks left in this issue?
Would like to work on those

@Charlie-XIAO Charlie-XIAO mentioned this issue Jan 9, 2024
Closed
26 tasks
@manuel-morales-a
Copy link
Contributor

Starting to work on 3.3. Metrics and scoring: quantifying the quality of predictions!

@manuel-morales-a manuel-morales-a mentioned this issue Feb 2, 2024
Merged
@Charlie-XIAO Charlie-XIAO mentioned this issue Feb 12, 2024
Merged
1 task
@linus-md
Copy link
Contributor
linus-md commented Feb 12, 2024 •
edited
Loading

@ArturoAmorQ do you have any feedback on #27920, #27921, #27919, #27915 and #27922?

@jmarintur jmarintur mentioned this issue Mar 12, 2024
Closed
@ArturoAmorQ ArturoAmorQ mentioned this issue Mar 13, 2024
Merged
@Anumon6395 Anumon6395 mentioned this issue Aug 14, 2024
Closed
@ArturoAmorQ
Copy link
Member Author

Thanks to all those who contributed to this issue. Closing as completed! 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation good first issue Easy with clear instructions to resolve Meta-issue General issue associated to an identified list of tasks
Projects
None yet
Milestone
No milestone
0