Add Installation section in docs overview #7027

souravsingh · 2016-07-17T14:03:30Z

Reference Issue

Fixes #7023 for adding an installation link on the documentation

What does this implement/fix? Explain your changes.

Adds a link to Installation on the overview page.

nelson-liu · 2016-07-17T14:07:17Z

hmm, i'd personally prefer installation to be to the right of "Quick Start" (then shift everything to the right or down to the leftmost column of the new row) as opposed to all the way at the bottom

nelson-liu · 2016-07-17T14:09:12Z

doc/documentation.rst

+                    of scikit-learn 
+                    </blockquote>
+                </div>
+


extraneous newline that was not there before

amueller · 2016-07-17T14:15:14Z

agree about the positioning. Can you please post a screenshot of the result?

souravsingh · 2016-07-17T14:16:45Z

@nelson-liu Thanks for the comments on the PR. I will look into positioning the Installation link

manu-chroma · 2016-08-09T07:27:58Z

@souravsingh Hey, are you still working on this one ?

souravsingh · 2016-08-09T07:31:35Z

@manu-chroma The PR is still open. I am working on updating it

nelson-liu · 2016-09-01T04:17:25Z

@souravsingh did you have a chance to get to this?

souravsingh · 2016-09-01T05:51:50Z

@nelson-liu I am working on the issue now

GaelVaroquaux · 2016-09-01T06:10:30Z

Only slightly related: we should link to winpython, https://winpython.github.io/, instead of Python(x,y) on the install page. Indeed, winpython is more maintained and more reactive these days (part of the developers of Python(x,y) moved to winpython).

@souravsingh : do you think that you can do that?

souravsingh · 2016-09-01T08:20:42Z

@GaelVaroquaux Sure, I can do it

souravsingh · 2016-09-25T16:30:01Z

@amueller I have made modifications to the documentation link. Here is the screenshot-

I am not able to figure out the problem with the last two links. Any help would be appreciated!

nelson-liu

The issue looks like it stems from your use of <div class="row-fluid">, which should be used once to encapsulate the 3 boxes that should be in a row. Here's how the document should be laid out:

<div class="row-fluid">
    <!-- one row -->
    <div class="span4 box">
      <!-- one box (1st col)-->
    </div>
    <div class="span4 box">
      <!-- one box (2nd col)-->
    </div>
    <div class="span4 box">
      <!-- one box (3rd col)-->
    </div>
</div>

nelson-liu · 2016-09-25T17:46:03Z

doc/documentation.rst

@@ -39,14 +38,23 @@ Documentation of scikit-learn 0.18.dev0
            </div>

          <!-- row -->
-            <div class="row-fluid">
+          <div class="row-fluid">


this indentation is off from the original file

nelson-liu · 2016-09-25T17:47:55Z

doc/documentation.rst

+                  to apply them.
+              </blockquote>
+          </div>
+          <div class="row-fluid">


i believe you dont want this tag here, because it isn't in a separate row

nelson-liu · 2016-09-25T17:48:02Z

doc/documentation.rst

                <div class="span4 box">
                    <h2><a href="tutorial/index.html">Tutorials</a></h2>
                    <blockquote>Useful tutorials for developing a feel
                    for some of scikit-learn's applications in the
                    machine learning field.
                    </blockquote>
                </div>
+                <div class="row-fluid">


same as above

nelson-liu · 2016-09-25T17:50:03Z

doc/documentation.rst

@@ -55,11 +63,7 @@ Documentation of scikit-learn 0.18.dev0
                            </blockquote>
                </div>



you want to end one of the rows here (every 3 span4 box divs)

nelson-liu · 2016-09-25T17:50:13Z

doc/documentation.rst

-                    <blockquote>Frequently asked questions about the project and contributing.
-                    </blockquote>
+                    <h2><a href="presentations.html">Additional Resources</a></h2>
+                                <blockquote>Talks given, slide-sets and other information relevant to scikit-learn.


indentation

souravsingh · 2016-09-26T09:11:32Z

@nelson-liu Thanks for the review. Apart from the comments, Is there a problem in the positioning of the links?

nelson-liu · 2016-09-26T17:58:30Z

maybe move "additional resources" to the end, seeing as they are additional anyway. No strong opinion on that though, cosmetically it looks good as it is (excepting the alignment / row issues, of course).

amueller · 2016-09-30T01:00:17Z

I have no idea what's happening with the pep8 check here :-/ @lesteve ?

lesteve · 2016-10-03T08:37:06Z

I have no idea what's happening with the pep8 check here :-/ @lesteve ?

It seems like the common ancestor between the PR branch and master is a commit in February 2016, not sure why ...

lesteve · 2016-10-03T08:55:39Z

It seems like the common ancestor between the PR branch and master is a commit in February 2016, not sure why ...

I guess that the problem can be fixed by a rebase on master. @souravsingh started working on this 3 months ago and at the time flake8_diff.sh didn't exist. I have no clue how on earth flake8_diff.sh is still found on Travis ...

amueller · 2016-10-03T13:38:54Z

thanks for investigating @lesteve

amueller · 2016-10-03T13:39:56Z

(Just do double check, the CI is run just on the PR, not on the PR merged into master, right?)

lesteve · 2016-10-03T13:42:32Z

(Just do double check, the test is run just on the PR, not on the PR merged into master, right?)

That was the indea indeed, so that the lines reported by flake8 match with what the PR author has locally.

which fixes the issue seen in scikit-learn#7027. Enhancements: * the script works on PRs targetting a fork rather than the reference repo * improved logic about when to unshallow the repo * fetching the upstream master branch into a reference rather than a branch (less intrusive for scripts than may run afterwards e.g. the ones in the after_success step) * Better logging messages

which fixes the issue seen in #7027. Enhancements: * the script works on PRs targetting a fork rather than the reference repo * improved logic about when to unshallow the repo * fetching the upstream master branch into a reference rather than a branch (less intrusive for scripts than may run afterwards e.g. the ones in the after_success step) * Better logging messages

lesteve · 2016-10-04T20:50:46Z

I merged #7575 and restarted the Travis flake8 build, that should get Travis green.

lesteve · 2016-10-05T07:37:37Z

Restarted the CircleCI build without cache manually since it seems to have fixed a similar issue in another PR.

dalmia · 2016-11-08T18:15:41Z

@souravsingh Are you still working on this?

souravsingh · 2016-11-08T18:17:34Z

My bad, I had forgotten about this. I will update the PR

souravsingh · 2017-02-26T12:14:24Z

I mistakenly deleted the branch for the PR. I will send a PR again.

which fixes the issue seen in scikit-learn#7027. Enhancements: * the script works on PRs targetting a fork rather than the reference repo * improved logic about when to unshallow the repo * fetching the upstream master branch into a reference rather than a branch (less intrusive for scripts than may run afterwards e.g. the ones in the after_success step) * Better logging messages

which fixes the issue seen in scikit-learn/scikit-learn#7027. Enhancements: * the script works on PRs targetting a fork rather than the reference repo * improved logic about when to unshallow the repo * fetching the upstream master branch into a reference rather than a branch (less intrusive for scripts than may run afterwards e.g. the ones in the after_success step) * Better logging messages

Add Installation section in docs overview

07d2788

nelson-liu reviewed Jul 17, 2016
View reviewed changes

doc/documentation.rst

of scikit-learn

</blockquote>

</div>

Copy link

Contributor

nelson-liu Jul 17, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

extraneous newline that was not there before

nelson-liu mentioned this pull request Jul 18, 2016

[MRG] Fix Issues #7023 and #7021 (User Guide Style Changes and Doc Overview Addition) #7035

Closed

Update to Documentation

9d3fbed

nelson-liu suggested changes Sep 25, 2016

View reviewed changes

lesteve mentioned this pull request Oct 3, 2016

[MRG + 1] FIX: Update install instructions for Windows #7550

Merged

lesteve mentioned this pull request Oct 4, 2016

[MRG] Fix flake8_diff.sh git repo unshallowing #7575

Merged

souravsingh closed this Feb 26, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Installation section in docs overview #7027

Add Installation section in docs overview #7027

souravsingh commented Jul 17, 2016

nelson-liu commented Jul 17, 2016 •

edited

Loading

nelson-liu Jul 17, 2016

amueller commented Jul 17, 2016

souravsingh commented Jul 17, 2016

manu-chroma commented Aug 9, 2016

souravsingh commented Aug 9, 2016

nelson-liu commented Sep 1, 2016

souravsingh commented Sep 1, 2016

GaelVaroquaux commented Sep 1, 2016

souravsingh commented Sep 1, 2016

souravsingh commented Sep 25, 2016

nelson-liu left a comment

nelson-liu Sep 25, 2016

nelson-liu Sep 25, 2016

nelson-liu Sep 25, 2016

nelson-liu Sep 25, 2016

nelson-liu Sep 25, 2016

souravsingh commented Sep 26, 2016

nelson-liu commented Sep 26, 2016

amueller commented Sep 30, 2016

lesteve commented Oct 3, 2016

lesteve commented Oct 3, 2016

amueller commented Oct 3, 2016

amueller commented Oct 3, 2016 •

edited

Loading

lesteve commented Oct 3, 2016

lesteve commented Oct 4, 2016

lesteve commented Oct 5, 2016

dalmia commented Nov 8, 2016

souravsingh commented Nov 8, 2016

souravsingh commented Feb 26, 2017

		@@ -55,11 +63,7 @@ Documentation of scikit-learn 0.18.dev0
		</blockquote>
		</div>

Add Installation section in docs overview #7027

Add Installation section in docs overview #7027

Conversation

souravsingh commented Jul 17, 2016

Reference Issue

What does this implement/fix? Explain your changes.

nelson-liu commented Jul 17, 2016 • edited Loading

nelson-liu Jul 17, 2016

Choose a reason for hiding this comment

amueller commented Jul 17, 2016

souravsingh commented Jul 17, 2016

manu-chroma commented Aug 9, 2016

souravsingh commented Aug 9, 2016

nelson-liu commented Sep 1, 2016

souravsingh commented Sep 1, 2016

GaelVaroquaux commented Sep 1, 2016

souravsingh commented Sep 1, 2016

souravsingh commented Sep 25, 2016

nelson-liu left a comment

Choose a reason for hiding this comment

nelson-liu Sep 25, 2016

Choose a reason for hiding this comment

nelson-liu Sep 25, 2016

Choose a reason for hiding this comment

nelson-liu Sep 25, 2016

Choose a reason for hiding this comment

nelson-liu Sep 25, 2016

Choose a reason for hiding this comment

nelson-liu Sep 25, 2016

Choose a reason for hiding this comment

souravsingh commented Sep 26, 2016

nelson-liu commented Sep 26, 2016

amueller commented Sep 30, 2016

lesteve commented Oct 3, 2016

lesteve commented Oct 3, 2016

amueller commented Oct 3, 2016

amueller commented Oct 3, 2016 • edited Loading

lesteve commented Oct 3, 2016

lesteve commented Oct 4, 2016

lesteve commented Oct 5, 2016

dalmia commented Nov 8, 2016

souravsingh commented Nov 8, 2016

souravsingh commented Feb 26, 2017

nelson-liu commented Jul 17, 2016 •

edited

Loading

amueller commented Oct 3, 2016 •

edited

Loading