Getting rid of set up instructions with pip section, and minor fixes to windows instructions

Author: Marc Garcia

pandas/guide/_sources/pandas_setup.rst.txt

@@ -38,6 +38,11 @@ via pip, conda or a zip.
 
 To get the latest development version:
 * Fork the `pandas repository <https://github.com/pandas-dev/pandas>`_ on GitHub by click on the top-right `Fork` button
+
+.. note::
+    **Window Users**: run the next commands in a Git Bash session in the directory where you want
+    to download pandas source code (download git for Windows <https://gitforwindows.org/> if needed).
+
 * In the terminal of your computer, in the directory where you want the copy of pandas source code, run:
 
     | ``git clone https://github.com/<your-github-username>/pandas``
@@ -54,10 +59,12 @@ repository:
 3. Set up a Python environment
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-3.a Python environment with Anaconda
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+* Download and install `Anaconda <https://www.anaconda.com/download/>`
+
+.. note::
+    **Window users**: run the next commands in the Anaconda Prompt (found in the Anaconda
+    folder of the Start menu.
 
-* Download and install `Anaconda <https://www.anaconda.com/download/>`_
 * Activate conda by one of the next (or equivalent, if you know what you're doing):
     * If you chose to prepend Anaconda to your PATH during install adding it to your ``~/.bashrc``, just restart your terminal.
     * Otherwise, run ``export PATH="<path-to-anaconda>/bin:$PATH"`` in your terminal. Keep in mind that it will be active exclusively in the terminal you run this command.
@@ -68,17 +75,23 @@ repository:
 * Install pandas development dependencies:
     ``conda install -c defaults -c conda-forge --file=<pandas-dir>/ci/requirements-optional-conda.txt``
 
-3.b Python environment with virtualenv and pip
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-TODO
-
 4. Compile C code in pandas
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Besides the Python `.py` files, pandas source code includes C/Cython files
 which need to be compiled in order to run the development version of pandas.
 
+.. note::
+    **Window Users**: you need to install the compiler toolset:
+    
+    For Python 3.6 - Install Visual Studio 2017, select the Python development workload
+    and the Native development tools option <https://www.visualstudio.com/>.
+    
+    For Python 2.7 - Microsoft Visual C++ Compiler for Python 2.7
+    <https://www.microsoft.com/download/details.aspx?id=44266>.
+    
+    After the installation, run the following commands in Anaconda Prompt.
+
 To compile these files simply run:
     | ``cd <pandas-dir>``
     | ``python setup.py build_ext --inplace``
@@ -93,6 +106,10 @@ to work on. Once you know which, you need to create a git branch for your
 changes. This will be useful when you have finished your changes, and you want
 to submit a pull request, so they are included in pandas.
 
+.. note::
+   **Window users**: run the next commands with Git Bash started at the cloned
+   pandas folder
+
 You can create a git branch running:
     | ``git checkout -b <new_branch_name>``
 

pandas/guide/_static/basic.css

@@ -4,7 +4,7 @@
  *
  * Sphinx stylesheet -- basic theme.
  *
- * :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2017 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */
@@ -445,14 +445,10 @@ dd {
     margin-left: 30px;
 }
 
-dt:target, span.highlighted {
+dt:target, .highlighted {
     background-color: #fbe54e;
 }
 
-rect.highlighted {
-    fill: #fbe54e;
-}
-
 dl.glossary dt {
     font-weight: bold;
     font-size: 1.1em;

pandas/guide/_static/doctools.js

@@ -4,7 +4,7 @@
  *
  * Sphinx JavaScript utilities for all documentation.
  *
- * :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2017 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */
@@ -45,7 +45,7 @@ jQuery.urlencode = encodeURIComponent;
  * it will always return arrays of strings for the value parts.
  */
 jQuery.getQueryParameters = function(s) {
-  if (typeof s === 'undefined')
+  if (typeof s == 'undefined')
     s = document.location.search;
   var parts = s.substr(s.indexOf('?') + 1).split('&');
   var result = {};
@@ -66,53 +66,29 @@ jQuery.getQueryParameters = function(s) {
  * span elements with the given class name.
  */
 jQuery.fn.highlightText = function(text, className) {
-  function highlight(node, addItems) {
-    if (node.nodeType === 3) {
+  function highlight(node) {
+    if (node.nodeType == 3) {
       var val = node.nodeValue;
       var pos = val.toLowerCase().indexOf(text);
       if (pos >= 0 && !jQuery(node.parentNode).hasClass(className)) {
-        var span;
-        var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg");
-        if (isInSVG) {
-          span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
-        } else {
-          span = document.createElement("span");
-          span.className = className;
-        }
+        var span = document.createElement("span");
+        span.className = className;
         span.appendChild(document.createTextNode(val.substr(pos, text.length)));
         node.parentNode.insertBefore(span, node.parentNode.insertBefore(
           document.createTextNode(val.substr(pos + text.length)),
           node.nextSibling));
         node.nodeValue = val.substr(0, pos);
-        if (isInSVG) {
-          var bbox = span.getBBox();
-          var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
-       	  rect.x.baseVal.value = bbox.x;
-          rect.y.baseVal.value = bbox.y;
-          rect.width.baseVal.value = bbox.width;
-          rect.height.baseVal.value = bbox.height;
-          rect.setAttribute('class', className);
-          var parentOfText = node.parentNode.parentNode;
-          addItems.push({
-              "parent": node.parentNode,
-              "target": rect});
-        }
       }
     }
     else if (!jQuery(node).is("button, select, textarea")) {
       jQuery.each(node.childNodes, function() {
-        highlight(this, addItems);
+        highlight(this);
       });
     }
   }
-  var addItems = [];
-  var result = this.each(function() {
-    highlight(this, addItems);
+  return this.each(function() {
+    highlight(this);
   });
-  for (var i = 0; i < addItems.length; ++i) {
-    jQuery(addItems[i].parent).before(addItems[i].target);
-  }
-  return result;
 };
 
 /*
@@ -155,21 +131,21 @@ var Documentation = {
    * i18n support
    */
   TRANSLATIONS : {},
-  PLURAL_EXPR : function(n) { return n === 1 ? 0 : 1; },
+  PLURAL_EXPR : function(n) { return n == 1 ? 0 : 1; },
   LOCALE : 'unknown',
 
   // gettext and ngettext don't access this so that the functions
   // can safely bound to a different name (_ = Documentation.gettext)
   gettext : function(string) {
     var translated = Documentation.TRANSLATIONS[string];
-    if (typeof translated === 'undefined')
+    if (typeof translated == 'undefined')
       return string;
-    return (typeof translated === 'string') ? translated : translated[0];
+    return (typeof translated == 'string') ? translated : translated[0];
   },
 
   ngettext : function(singular, plural, n) {
     var translated = Documentation.TRANSLATIONS[singular];
-    if (typeof translated === 'undefined')
+    if (typeof translated == 'undefined')
       return (n == 1) ? singular : plural;
     return translated[Documentation.PLURALEXPR(n)];
   },
@@ -204,7 +180,7 @@ var Documentation = {
    * see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075
    */
   fixFirefoxAnchorBug : function() {
-    if (document.location.hash && $.browser.mozilla)
+    if (document.location.hash)
       window.setTimeout(function() {
         document.location.href += '';
       }, 10);
@@ -240,7 +216,7 @@ var Documentation = {
       var src = $(this).attr('src');
       var idnum = $(this).attr('id').substr(7);
       $('tr.cg-' + idnum).toggle();
-      if (src.substr(-9) === 'minus.png')
+      if (src.substr(-9) == 'minus.png')
         $(this).attr('src', src.substr(0, src.length-9) + 'plus.png');
       else
         $(this).attr('src', src.substr(0, src.length-8) + 'minus.png');
@@ -272,7 +248,7 @@ var Documentation = {
     var path = document.location.pathname;
     var parts = path.split(/\//);
     $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() {
-      if (this === '..')
+      if (this == '..')
         parts.pop();
     });
     var url = parts.join('/');

pandas/guide/_static/searchtools.js

@@ -4,7 +4,7 @@
  *
  * Sphinx JavaScript utilities for the full-text search.
  *
- * :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2017 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */
@@ -540,9 +540,6 @@ var Search = {
           });
         } else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) {
           var suffix = DOCUMENTATION_OPTIONS.SOURCELINK_SUFFIX;
-          if (suffix === undefined) {
-            suffix = '.txt';
-          }
           $.ajax({url: DOCUMENTATION_OPTIONS.URL_ROOT + '_sources/' + item[5] + (item[5].slice(-suffix.length) === suffix ? '' : suffix),
                   dataType: "text",
                   complete: function(jqxhr, textstatus) {

pandas/guide/_static/websupport.js

@@ -4,7 +4,7 @@
  *
  * sphinx.websupport utilities for all documentation.
  *
- * :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2017 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */

pandas/guide/contents.html

@@ -107,7 +107,7 @@ <h3>Quick search</h3>
       &copy;.
 
       |
-      Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.6</a>
+      Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.3</a>
       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
 
       |

pandas/guide/genindex.html

@@ -82,7 +82,7 @@ <h3>Quick search</h3>
       &copy;.
 
       |
-      Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.6</a>
+      Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.3</a>
       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
 
     </div>

pandas/guide/organizers.html

@@ -289,7 +289,7 @@ <h3>Quick search</h3>
       &copy;.
 
       |
-      Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.6</a>
+      Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.3</a>
       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
 
       |

pandas/guide/pandas_docstring.html

@@ -693,7 +693,7 @@ <h3>Quick search</h3>
       &copy;.
 
       |
-      Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.6</a>
+      Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.3</a>
       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
 
       |

pandas/guide/pandas_pr.html

@@ -215,7 +215,7 @@ <h3>Quick search</h3>
       &copy;.
 
       |
-      Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.6</a>
+      Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.3</a>
       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
 
       |

pandas/guide/pandas_setup.html

@@ -72,13 +72,21 @@ <h3>2. Get the pandas source code<a class="headerlink" href="#get-the-pandas-sou
 version of pandas. Do not make them to a version downloaded from the Internet
 via pip, conda or a zip.</p>
 <p>To get the latest development version:
-* Fork the <a class="reference external" href="https://github.com/pandas-dev/pandas">pandas repository</a> on GitHub by click on the top-right <cite>Fork</cite> button
-* In the terminal of your computer, in the directory where you want the copy of pandas source code, run:</p>
+* Fork the <a class="reference external" href="https://github.com/pandas-dev/pandas">pandas repository</a> on GitHub by click on the top-right <cite>Fork</cite> button</p>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p class="last"><strong>Window Users</strong>: run the next commands in a Git Bash session in the directory where you want
+to download pandas source code (download git for Windows &lt;<a class="reference external" href="https://gitforwindows.org/">https://gitforwindows.org/</a>&gt; if needed).</p>
+</div>
+<ul>
+<li><p class="first">In the terminal of your computer, in the directory where you want the copy of pandas source code, run:</p>
 <blockquote>
 <div><div class="line-block">
 <div class="line"><code class="docutils literal"><span class="pre">git</span> <span class="pre">clone</span> <span class="pre">https://github.com/&lt;your-github-username&gt;/pandas</span></code></div>
 </div>
 </div></blockquote>
+</li>
+</ul>
 <p>This will create a directory named <cite>pandas</cite>, containing the latest version of
 the source code. We will name this directory <cite>&lt;pandas-dir&gt;</cite> in the rest of
 this document.</p>
@@ -92,10 +100,15 @@ <h3>2. Get the pandas source code<a class="headerlink" href="#get-the-pandas-sou
 </div>
 <div class="section" id="set-up-a-python-environment">
 <h3>3. Set up a Python environment<a class="headerlink" href="#set-up-a-python-environment" title="Permalink to this headline">¶</a></h3>
-<div class="section" id="a-python-environment-with-anaconda">
-<h4>3.a Python environment with Anaconda<a class="headerlink" href="#a-python-environment-with-anaconda" title="Permalink to this headline">¶</a></h4>
 <ul class="simple">
-<li>Download and install <a class="reference external" href="https://www.anaconda.com/download/">Anaconda</a></li>
+<li>Download and install <cite>Anaconda &lt;https://www.anaconda.com/download/&gt;</cite></li>
+</ul>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p class="last"><strong>Window users</strong>: run the next commands in the Anaconda Prompt (found in the Anaconda
+folder of the Start menu.</p>
+</div>
+<ul class="simple">
 <li><dl class="first docutils">
 <dt>Activate conda by one of the next (or equivalent, if you know what you’re doing):</dt>
 <dd><ul class="first last">
@@ -122,15 +135,19 @@ <h4>3.a Python environment with Anaconda<a class="headerlink" href="#a-python-en
 </li>
 </ul>
 </div>
-<div class="section" id="b-python-environment-with-virtualenv-and-pip">
-<h4>3.b Python environment with virtualenv and pip<a class="headerlink" href="#b-python-environment-with-virtualenv-and-pip" title="Permalink to this headline">¶</a></h4>
-<p>TODO</p>
-</div>
-</div>
 <div class="section" id="compile-c-code-in-pandas">
 <h3>4. Compile C code in pandas<a class="headerlink" href="#compile-c-code-in-pandas" title="Permalink to this headline">¶</a></h3>
 <p>Besides the Python <cite>.py</cite> files, pandas source code includes C/Cython files
 which need to be compiled in order to run the development version of pandas.</p>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p><strong>Window Users</strong>: you need to install the compiler toolset:</p>
+<p>For Python 3.6 - Install Visual Studio 2017, select the Python development workload
+and the Native development tools option &lt;<a class="reference external" href="https://www.visualstudio.com/">https://www.visualstudio.com/</a>&gt;.</p>
+<p>For Python 2.7 - Microsoft Visual C++ Compiler for Python 2.7
+&lt;<a class="reference external" href="https://www.microsoft.com/download/details.aspx?id=44266">https://www.microsoft.com/download/details.aspx?id=44266</a>&gt;.</p>
+<p class="last">After the installation, run the following commands in Anaconda Prompt.</p>
+</div>
 <dl class="docutils">
 <dt>To compile these files simply run:</dt>
 <dd><div class="first last line-block">
@@ -147,6 +164,11 @@ <h3>5. Create a branch and start coding<a class="headerlink" href="#create-a-bra
 to work on. Once you know which, you need to create a git branch for your
 changes. This will be useful when you have finished your changes, and you want
 to submit a pull request, so they are included in pandas.</p>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p class="last"><strong>Window users</strong>: run the next commands with Git Bash started at the cloned
+pandas folder</p>
+</div>
 <dl class="docutils">
 <dt>You can create a git branch running:</dt>
 <dd><div class="first last line-block">
@@ -190,11 +212,7 @@ <h3><a href="contents.html">Table Of Contents</a></h3>
 <li><a class="reference internal" href="#instructions">Instructions</a><ul>
 <li><a class="reference internal" href="#create-a-github-account">1. Create a GitHub account</a></li>
 <li><a class="reference internal" href="#get-the-pandas-source-code">2. Get the pandas source code</a></li>
-<li><a class="reference internal" href="#set-up-a-python-environment">3. Set up a Python environment</a><ul>
-<li><a class="reference internal" href="#a-python-environment-with-anaconda">3.a Python environment with Anaconda</a></li>
-<li><a class="reference internal" href="#b-python-environment-with-virtualenv-and-pip">3.b Python environment with virtualenv and pip</a></li>
-</ul>
-</li>
+<li><a class="reference internal" href="#set-up-a-python-environment">3. Set up a Python environment</a></li>
 <li><a class="reference internal" href="#compile-c-code-in-pandas">4. Compile C code in pandas</a></li>
 <li><a class="reference internal" href="#create-a-branch-and-start-coding">5. Create a branch and start coding</a></li>
 </ul>
@@ -236,7 +254,7 @@ <h3>Quick search</h3>
       &copy;.
 
       |
-      Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.6</a>
+      Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.3</a>
       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
 
       |