Skip to content

DOC: Link to LDA in example#5984

Merged
amueller merged 1 commit intoscikit-learn:masterfrom
maniteja123:issue5876
Oct 25, 2016
Merged

DOC: Link to LDA in example#5984
amueller merged 1 commit intoscikit-learn:masterfrom
maniteja123:issue5876

Conversation

@maniteja123
Copy link
Copy Markdown
Contributor

@maniteja123 maniteja123 commented Dec 8, 2015

Provide link to LDA and NMF in the example tutorial closes #5876.

I have tried including the link to LDA and NMF in the example. In my local build, the link to NMF is active, but the link to LDA isn't getting active.

Please do check out the branch and let me know if something is wrong in my local build. This is my first PR in scikit-learn.


This change is Reviewable

@amueller
Copy link
Copy Markdown
Member

amueller commented Dec 8, 2015

LGTM though this is not the issue #5876.

@maniteja123
Copy link
Copy Markdown
Contributor Author

Sorry, I just found out the issue is the link broken in the code snippet. Could you give an idea of how the links are in general generated for the code snippets ? I mean should the classes be listed somewhere in particular like in classes.rst.

@amueller
Copy link
Copy Markdown
Member

it's done in gen_rst.py in the doc folder.

@maniteja123
Copy link
Copy Markdown
Contributor Author

Thanks, I will try to look into this file.

For example, the link to FeatureUnion is not active in http://scikit-learn.org/stable/auto_examples/feature_stacker.html but is active in http://scikit-learn.org/stable/auto_examples/hetero_feature_union.html.

Actually also in my local build, many other links are also not getting generated. For example, http://scikit-learn.org/stable/auto_examples/feature_stacker.html , the link to even GridSearchCV is not getting generated in local build, though it is working in the stable website.
I am building the docs using make html-noplot.

Is there anything I am missing in this ? should I delete the whole docs/_build/html and run it again ? Thanks and apologies for asking basic questions but I am new to this whole setup.

@amueller
Copy link
Copy Markdown
Member

Yeah, maybe try making clean and rebuilding. I'm not sure why there are
differences between stable and your local build.
Dev is also working:
http://scikit-learn.org/dev/auto_examples/feature_stacker.html

On 12/10/2015 01:44 PM, Maniteja Nandana wrote:

Thanks, I will try to look into tomorrow.

For example, the link to |FeatureUnion| is not active in
http://scikit-learn.org/stable/auto_examples/feature_stacker.html but
is active in
http://scikit-learn.org/stable/auto_examples/hetero_feature_union.html.

Actually also in my local build, many other links are also not getting
generated. For example,
http://scikit-learn.org/stable/auto_examples/feature_stacker.html ,
the link to even |GridSearchCV| is not getting generated in local
build, though it is working in the stable website.
I am building the docs using |make html-noplot|.

Is there anything I am missing in this ? should I delete the whole
docs/build/_html and run it again ? Thanks and apologies for asking
basic questions but I am new to this whole setup.


Reply to this email directly or view it on GitHub
#5984 (comment).

@maniteja123
Copy link
Copy Markdown
Contributor Author

I am sorry for the delay in following up on the issue since I had my exams. I did try running make clean and build it again. Do I need to do any in-place build for it to work or is it anything I am missing?
Any heads up will be really helpful. Thanks !

@amueller
Copy link
Copy Markdown
Member

Sorry, not entirely sure what the problem is. So you built the website and didn't see a change?

@amueller
Copy link
Copy Markdown
Member

merging as minor doc addition.

@amueller amueller merged commit 9d535ad into scikit-learn:master Oct 25, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Website: link to lda broken in example

2 participants