Skip to content
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: Add a source button for the API documentation to go to the source code on GitHub #1067

Open
sylvaincom opened this issue Jan 9, 2025 · 1 comment · May be fixed by #1090
Open

docs: Add a source button for the API documentation to go to the source code on GitHub #1067

sylvaincom opened this issue Jan 9, 2025 · 1 comment · May be fixed by #1090
Labels
documentation Improvements or additions to documentation

Comments

@sylvaincom
Copy link
Contributor

sylvaincom commented Jan 9, 2025

Which part of the documentation needs improvement?

API documentation

Describe the problem found in the documentation

Contrary to skore v0.5.1, scikit-learn has this source button from the API documentation that enables to jump to the source code on GitHub (on the video my laptop is lagging a little) :

Enregistrement.de.l.ecran.2025-01-09.a.16.37.04.mov

Suggested improvement

Implement the same Sphinx trick as in scikit-learn.

Additional context

No response

@sylvaincom sylvaincom added documentation Improvements or additions to documentation needs-triage This has been recently submitted and needs attention labels Jan 9, 2025
@sylvaincom sylvaincom changed the title doc: Add a source button for the API documentation to go to the source code on GitHub docs: Add a source button for the API documentation to go to the source code on GitHub Jan 9, 2025
@sylvaincom sylvaincom removed the needs-triage This has been recently submitted and needs attention label Jan 9, 2025
@glemaitre
Copy link
Member

The related documentation to turn-on the feature is available here: https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/source-buttons.html

We need to define a couple of variables in the conf.py and it should be fine.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
2 participants