8000 Links from documentation to Github · Issue #1680 · scikit-learn/scikit-learn · GitHub
[go: up one dir, main page]
Skip to content

Links from documentation to Github #1680

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
tobigue opened this issue Feb 14, 2013 · 7 comments
Closed

Links from documentation to Github #1680

tobigue opened this issue Feb 14, 2013 · 7 comments
Labels
Documentation

Comments

@tobigue
Copy link
tobigue commented Feb 14, 2013

I thought it would be very convenient to have a link from a documentation page to the file on Github implementing the class/method. Maybe this could be automated somehow when the docs for the modules are generated?
@tobigue
Copy link
Author
tobigue commented Feb 14, 2013

Example:

Having a link on

http://scikit-learn.org/dev/modules/generated/sklearn.naive_bayes.MultinomialNB.html

to

https://github.com/scikit-learn/scikit-learn/blob/master/sklearn/naive_bayes.py#L279

@amueller
Copy link
Member

In general, I think that might be nice. Though it might lead to us getting lazy in documentation.
I think people should never have to read the code to use an estimator. If they do need to, then the documentation is insufficient.
Do if you have specific things that you think are missing from the docs, I think we should rather add them there.

@amueller
Copy link
Member

Gah! I now see the problem with finding coef_ that I didn't see before. There is a misformatting in the table. Stupid sphinx/numpy-ext! it is driving me nuts :-/ ok I think I misread it.

@jaquesgrobler
Copy link
Member

Any new thoughts on this one? Shall we try implement it or is it not necessary?

@AlexandreAbraham
Copy link
Contributor

The sphinx.ext.viewcode extension allows that. However, last time I checked, it generated a page with the code instead of linking to a github website. However, it can be modified to handle that without too much difficulty I think.

@jaquesgrobler
Copy link
Member

Thanks for the info @AlexandreAbraham .. if we decide to add this, I'll definitely check that route out 👍

@jaquesgrobler jaquesgrobler mentioned this issue Jan 21, 2014
Merged
@larsmans
Copy link
Member

Closing as solved by #2777.

@Micky774 Micky774 mentioned this issue Jun 16, 2022
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
5 participants
@larsmans @amueller @jaquesgrobler @tobigue @AlexandreAbraham
0