Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Add Installation section in docs overview#7027

Closed
souravsingh wants to merge 2 commits into
scikit-learn:masterfrom
souravsingh:issue-7023
Closed

Add Installation section in docs overview#7027
souravsingh wants to merge 2 commits into
scikit-learn:masterfrom
souravsingh:issue-7023

Conversation

@souravsingh

Copy link
Copy Markdown
Contributor

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

nelson-liu commented Jul 17, 2016

Copy link
Copy Markdown
Contributor

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

Comment thread doc/documentation.rst Outdated
of scikit-learn
</blockquote>
</div>

Copy link
Copy Markdown
Contributor

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

@amueller

Copy link
Copy Markdown
Member

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

@souravsingh

Copy link
Copy Markdown
Contributor Author

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

@manu-chroma

Copy link
Copy Markdown
Contributor

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

@souravsingh

Copy link
Copy Markdown
Contributor Author

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

@nelson-liu

Copy link
Copy Markdown
Contributor

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

@souravsingh

Copy link
Copy Markdown
Contributor Author

@nelson-liu I am working on the issue now

@GaelVaroquaux

Copy link
Copy Markdown
Member

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

Copy link
Copy Markdown
Contributor Author

@GaelVaroquaux Sure, I can do it

@souravsingh

Copy link
Copy Markdown
Contributor Author

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

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

@nelson-liu nelson-liu left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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>

Comment thread doc/documentation.rst

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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

this indentation is off from the original file

Comment thread doc/documentation.rst
to apply them.
</blockquote>
</div>
<div class="row-fluid">

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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

Comment thread doc/documentation.rst
machine learning field.
</blockquote>
</div>
<div class="row-fluid">

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

same as above

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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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

Comment thread 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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

indentation

@souravsingh

Copy link
Copy Markdown
Contributor Author

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

@nelson-liu

Copy link
Copy Markdown
Contributor

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

Copy link
Copy Markdown
Member

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

@lesteve

lesteve commented Oct 3, 2016

Copy link
Copy Markdown
Member

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

lesteve commented Oct 3, 2016

Copy link
Copy Markdown
Member

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

amueller commented Oct 3, 2016

Copy link
Copy Markdown
Member

thanks for investigating @lesteve

@amueller

amueller commented Oct 3, 2016

Copy link
Copy Markdown
Member

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

@lesteve

lesteve commented Oct 3, 2016

Copy link
Copy Markdown
Member

(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.

lesteve added a commit to lesteve/scikit-learn that referenced this pull request Oct 4, 2016
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
lesteve added a commit that referenced this pull request Oct 4, 2016
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

lesteve commented Oct 4, 2016

Copy link
Copy Markdown
Member

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

@lesteve

lesteve commented Oct 5, 2016

Copy link
Copy Markdown
Member

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

@dalmia

dalmia commented Nov 8, 2016

Copy link
Copy Markdown
Contributor

@souravsingh Are you still working on this?

@souravsingh

Copy link
Copy Markdown
Contributor Author

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

@souravsingh

Copy link
Copy Markdown
Contributor Author

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

Sundrique pushed a commit to Sundrique/scikit-learn that referenced this pull request Jun 14, 2017
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
paulha pushed a commit to paulha/scikit-learn that referenced this pull request Aug 19, 2017
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
csinva pushed a commit to Yu-Group/iterative-Random-Forest that referenced this pull request Nov 11, 2021
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
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.

Add "installation" section to the documentation overview page.

7 participants