Skip to content

Commit dbb82a3

Browse files
author
Marc Garcia
committed
Getting rid of set up instructions with pip section, and minor fixes to windows instructions
1 parent 57c9988 commit dbb82a3

15 files changed

+98
-103
lines changed

‎pandas/guide/_sources/pandas_setup.rst.txt

Lines changed: 25 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,11 @@ via pip, conda or a zip.
3838

3939
To get the latest development version:
4040
* Fork the `pandas repository <https://github.com/pandas-dev/pandas>`_ on GitHub by click on the top-right `Fork` button
41+
42+
.. note::
43+
**Window Users**: run the next commands in a Git Bash session in the directory where you want
44+
to download pandas source code (download git for Windows <https://gitforwindows.org/> if needed).
45+
4146
* In the terminal of your computer, in the directory where you want the copy of pandas source code, run:
4247

4348
| ``git clone https://github.com/<your-github-username>/pandas``
@@ -54,10 +59,12 @@ repository:
5459
3. Set up a Python environment
5560
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5661

57-
3.a Python environment with Anaconda
58-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
62+
* Download and install `Anaconda <https://www.anaconda.com/download/>`
63+
64+
.. note::
65+
**Window users**: run the next commands in the Anaconda Prompt (found in the Anaconda
66+
folder of the Start menu.
5967

60-
* Download and install `Anaconda <https://www.anaconda.com/download/>`_
6168
* Activate conda by one of the next (or equivalent, if you know what you're doing):
6269
* If you chose to prepend Anaconda to your PATH during install adding it to your ``~/.bashrc``, just restart your terminal.
6370
* 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:
6875
* Install pandas development dependencies:
6976
``conda install -c defaults -c conda-forge --file=<pandas-dir>/ci/requirements-optional-conda.txt``
7077

71-
3.b Python environment with virtualenv and pip
72-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
73-
74-
TODO
75-
7678
4. Compile C code in pandas
7779
~~~~~~~~~~~~~~~~~~~~~~~~~~~
7880

7981
Besides the Python `.py` files, pandas source code includes C/Cython files
8082
which need to be compiled in order to run the development version of pandas.
8183

84+
.. note::
85+
**Window Users**: you need to install the compiler toolset:
86+
87+
For Python 3.6 - Install Visual Studio 2017, select the Python development workload
88+
and the Native development tools option <https://www.visualstudio.com/>.
89+
90+
For Python 2.7 - Microsoft Visual C++ Compiler for Python 2.7
91+
<https://www.microsoft.com/download/details.aspx?id=44266>.
92+
93+
After the installation, run the following commands in Anaconda Prompt.
94+
8295
To compile these files simply run:
8396
| ``cd <pandas-dir>``
8497
| ``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
93106
changes. This will be useful when you have finished your changes, and you want
94107
to submit a pull request, so they are included in pandas.
95108

109+
.. note::
110+
**Window users**: run the next commands with Git Bash started at the cloned
111+
pandas folder
112+
96113
You can create a git branch running:
97114
| ``git checkout -b <new_branch_name>``
98115

‎pandas/guide/_static/basic.css

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
*
55
* Sphinx stylesheet -- basic theme.
66
*
7-
* :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
7+
* :copyright: Copyright 2007-2017 by the Sphinx team, see AUTHORS.
88
* :license: BSD, see LICENSE for details.
99
*
1010
*/
@@ -445,14 +445,10 @@ dd {
445445
margin-left: 30px;
446446
}
447447

448-
dt:target, span.highlighted {
448+
dt:target, .highlighted {
449449
background-color: #fbe54e;
450450
}
451451

452-
rect.highlighted {
453-
fill: #fbe54e;
454-
}
455-
456452
dl.glossary dt {
457453
font-weight: bold;
458454
font-size: 1.1em;

‎pandas/guide/_static/doctools.js

Lines changed: 16 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
*
55
* Sphinx JavaScript utilities for all documentation.
66
*
7-
* :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
7+
* :copyright: Copyright 2007-2017 by the Sphinx team, see AUTHORS.
88
* :license: BSD, see LICENSE for details.
99
*
1010
*/
@@ -45,7 +45,7 @@ jQuery.urlencode = encodeURIComponent;
4545
* it will always return arrays of strings for the value parts.
4646
*/
4747
jQuery.getQueryParameters = function(s) {
48-
if (typeof s === 'undefined')
48+
if (typeof s == 'undefined')
4949
s = document.location.search;
5050
var parts = s.substr(s.indexOf('?') + 1).split('&');
5151
var result = {};
@@ -66,53 +66,29 @@ jQuery.getQueryParameters = function(s) {
6666
* span elements with the given class name.
6767
*/
6868
jQuery.fn.highlightText = function(text, className) {
69-
function highlight(node, addItems) {
70-
if (node.nodeType === 3) {
69+
function highlight(node) {
70+
if (node.nodeType == 3) {
7171
var val = node.nodeValue;
7272
var pos = val.toLowerCase().indexOf(text);
7373
if (pos >= 0 && !jQuery(node.parentNode).hasClass(className)) {
74-
var span;
75-
var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg");
76-
if (isInSVG) {
77-
span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
78-
} else {
79-
span = document.createElement("span");
80-
span.className = className;
81-
}
74+
var span = document.createElement("span");
75+
span.className = className;
8276
span.appendChild(document.createTextNode(val.substr(pos, text.length)));
8377
node.parentNode.insertBefore(span, node.parentNode.insertBefore(
8478
document.createTextNode(val.substr(pos + text.length)),
8579
node.nextSibling));
8680
node.nodeValue = val.substr(0, pos);
87-
if (isInSVG) {
88-
var bbox = span.getBBox();
89-
var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
90-
rect.x.baseVal.value = bbox.x;
91-
rect.y.baseVal.value = bbox.y;
92-
rect.width.baseVal.value = bbox.width;
93-
rect.height.baseVal.value = bbox.height;
94-
rect.setAttribute('class', className);
95-
var parentOfText = node.parentNode.parentNode;
96-
addItems.push({
97-
"parent": node.parentNode,
98-
"target": rect});
99-
}
10081
}
10182
}
10283
else if (!jQuery(node).is("button, select, textarea")) {
10384
jQuery.each(node.childNodes, function() {
104-
highlight(this, addItems);
85+
highlight(this);
10586
});
10687
}
10788
}
108-
var addItems = [];
109-
var result = this.each(function() {
110-
highlight(this, addItems);
89+
return this.each(function() {
90+
highlight(this);
11191
});
112-
for (var i = 0; i < addItems.length; ++i) {
113-
jQuery(addItems[i].parent).before(addItems[i].target);
114-
}
115-
return result;
11692
};
11793

11894
/*
@@ -155,21 +131,21 @@ var Documentation = {
155131
* i18n support
156132
*/
157133
TRANSLATIONS : {},
158-
PLURAL_EXPR : function(n) { return n === 1 ? 0 : 1; },
134+
PLURAL_EXPR : function(n) { return n == 1 ? 0 : 1; },
159135
LOCALE : 'unknown',
160136

161137
// gettext and ngettext don't access this so that the functions
162138
// can safely bound to a different name (_ = Documentation.gettext)
163139
gettext : function(string) {
164140
var translated = Documentation.TRANSLATIONS[string];
165-
if (typeof translated === 'undefined')
141+
if (typeof translated == 'undefined')
166142
return string;
167-
return (typeof translated === 'string') ? translated : translated[0];
143+
return (typeof translated == 'string') ? translated : translated[0];
168144
},
169145

170146
ngettext : function(singular, plural, n) {
171147
var translated = Documentation.TRANSLATIONS[singular];
172-
if (typeof translated === 'undefined')
148+
if (typeof translated == 'undefined')
173149
return (n == 1) ? singular : plural;
174150
return translated[Documentation.PLURALEXPR(n)];
175151
},
@@ -204,7 +180,7 @@ var Documentation = {
204180
* see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075
205181
*/
206182
fixFirefoxAnchorBug : function() {
207-
if (document.location.hash && $.browser.mozilla)
183+
if (document.location.hash)
208184
window.setTimeout(function() {
209185
document.location.href += '';
210186
}, 10);
@@ -240,7 +216,7 @@ var Documentation = {
240216
var src = $(this).attr('src');
241217
var idnum = $(this).attr('id').substr(7);
242218
$('tr.cg-' + idnum).toggle();
243-
if (src.substr(-9) === 'minus.png')
219+
if (src.substr(-9) == 'minus.png')
244220
$(this).attr('src', src.substr(0, src.length-9) + 'plus.png');
245221
else
246222
$(this).attr('src', src.substr(0, src.length-8) + 'minus.png');
@@ -272,7 +248,7 @@ var Documentation = {
272248
var path = document.location.pathname;
273249
var parts = path.split(/\//);
274250
$.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() {
275-
if (this === '..')
251+
if (this == '..')
276252
parts.pop();
277253
});
278254
var url = parts.join('/');

‎pandas/guide/_static/searchtools.js

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
*
55
* Sphinx JavaScript utilities for the full-text search.
66
*
7-
* :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
7+
* :copyright: Copyright 2007-2017 by the Sphinx team, see AUTHORS.
88
* :license: BSD, see LICENSE for details.
99
*
1010
*/
@@ -540,9 +540,6 @@ var Search = {
540540
});
541541
} else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) {
542542
var suffix = DOCUMENTATION_OPTIONS.SOURCELINK_SUFFIX;
543-
if (suffix === undefined) {
544-
suffix = '.txt';
545-
}
546543
$.ajax({url: DOCUMENTATION_OPTIONS.URL_ROOT + '_sources/' + item[5] + (item[5].slice(-suffix.length) === suffix ? '' : suffix),
547544
dataType: "text",
548545
complete: function(jqxhr, textstatus) {

‎pandas/guide/_static/websupport.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
*
55
* sphinx.websupport utilities for all documentation.
66
*
7-
* :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
7+
* :copyright: Copyright 2007-2017 by the Sphinx team, see AUTHORS.
88
* :license: BSD, see LICENSE for details.
99
*
1010
*/

‎pandas/guide/contents.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ <h3>Quick search</h3>
107107
&copy;.
108108

109109
|
110-
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.6</a>
110+
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.3</a>
111111
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
112112

113113
|

‎pandas/guide/genindex.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ <h3>Quick search</h3>
8282
&copy;.
8383

8484
|
85-
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.6</a>
85+
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.3</a>
8686
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
8787

8888
</div>

‎pandas/guide/organizers.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -289,7 +289,7 @@ <h3>Quick search</h3>
289289
&copy;.
290290

291291
|
292-
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.6</a>
292+
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.3</a>
293293
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
294294

295295
|

‎pandas/guide/pandas_docstring.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -693,7 +693,7 @@ <h3>Quick search</h3>
693693
&copy;.
694694

695695
|
696-
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.6</a>
696+
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.3</a>
697697
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
698698

699699
|

‎pandas/guide/pandas_pr.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,7 @@ <h3>Quick search</h3>
215215
&copy;.
216216

217217
|
218-
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.6</a>
218+
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.3</a>
219219
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
220220

221221
|

‎pandas/guide/pandas_setup.html

Lines changed: 34 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -72,13 +72,21 @@ <h3>2. Get the pandas source code<a class="headerlink" href="#get-the-pandas-sou
7272
version of pandas. Do not make them to a version downloaded from the Internet
7373
via pip, conda or a zip.</p>
7474
<p>To get the latest development version:
75-
* 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
76-
* In the terminal of your computer, in the directory where you want the copy of pandas source code, run:</p>
75+
* 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>
76+
<div class="admonition note">
77+
<p class="first admonition-title">Note</p>
78+
<p class="last"><strong>Window Users</strong>: run the next commands in a Git Bash session in the directory where you want
79+
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>
80+
</div>
81+
<ul>
82+
<li><p class="first">In the terminal of your computer, in the directory where you want the copy of pandas source code, run:</p>
7783
<blockquote>
7884
<div><div class="line-block">
7985
<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>
8086
</div>
8187
</div></blockquote>
88+
</li>
89+
</ul>
8290
<p>This will create a directory named <cite>pandas</cite>, containing the latest version of
8391
the source code. We will name this directory <cite>&lt;pandas-dir&gt;</cite> in the rest of
8492
this document.</p>
@@ -92,10 +100,15 @@ <h3>2. Get the pandas source code<a class="headerlink" href="#get-the-pandas-sou
92100
</div>
93101
<div class="section" id="set-up-a-python-environment">
94102
<h3>3. Set up a Python environment<a class="headerlink" href="#set-up-a-python-environment" title="Permalink to this headline"></a></h3>
95-
<div class="section" id="a-python-environment-with-anaconda">
96-
<h4>3.a Python environment with Anaconda<a class="headerlink" href="#a-python-environment-with-anaconda" title="Permalink to this headline"></a></h4>
97103
<ul class="simple">
98-
<li>Download and install <a class="reference external" href="https://www.anaconda.com/download/">Anaconda</a></li>
104+
<li>Download and install <cite>Anaconda &lt;https://www.anaconda.com/download/&gt;</cite></li>
105+
</ul>
106+
<div class="admonition note">
107+
<p class="first admonition-title">Note</p>
108+
<p class="last"><strong>Window users</strong>: run the next commands in the Anaconda Prompt (found in the Anaconda
109+
folder of the Start menu.</p>
110+
</div>
111+
<ul class="simple">
99112
<li><dl class="first docutils">
100113
<dt>Activate conda by one of the next (or equivalent, if you know what you’re doing):</dt>
101114
<dd><ul class="first last">
@@ -122,15 +135,19 @@ <h4>3.a Python environment with Anaconda<a class="headerlink" href="#a-python-en
122135
</li>
123136
</ul>
124137
</div>
125-
<div class="section" id="b-python-environment-with-virtualenv-and-pip">
126-
<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>
127-
<p>TODO</p>
128-
</div>
129-
</div>
130138
<div class="section" id="compile-c-code-in-pandas">
131139
<h3>4. Compile C code in pandas<a class="headerlink" href="#compile-c-code-in-pandas" title="Permalink to this headline"></a></h3>
132140
<p>Besides the Python <cite>.py</cite> files, pandas source code includes C/Cython files
133141
which need to be compiled in order to run the development version of pandas.</p>
142+
<div class="admonition note">
143+
<p class="first admonition-title">Note</p>
144+
<p><strong>Window Users</strong>: you need to install the compiler toolset:</p>
145+
<p>For Python 3.6 - Install Visual Studio 2017, select the Python development workload
146+
and the Native development tools option &lt;<a class="reference external" href="https://www.visualstudio.com/">https://www.visualstudio.com/</a>&gt;.</p>
147+
<p>For Python 2.7 - Microsoft Visual C++ Compiler for Python 2.7
148+
&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>
149+
<p class="last">After the installation, run the following commands in Anaconda Prompt.</p>
150+
</div>
134151
<dl class="docutils">
135152
<dt>To compile these files simply run:</dt>
136153
<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
147164
to work on. Once you know which, you need to create a git branch for your
148165
changes. This will be useful when you have finished your changes, and you want
149166
to submit a pull request, so they are included in pandas.</p>
167+
<div class="admonition note">
168+
<p class="first admonition-title">Note</p>
169+
<p class="last"><strong>Window users</strong>: run the next commands with Git Bash started at the cloned
170+
pandas folder</p>
171+
</div>
150172
<dl class="docutils">
151173
<dt>You can create a git branch running:</dt>
152174
<dd><div class="first last line-block">
@@ -190,11 +212,7 @@ <h3><a href="contents.html">Table Of Contents</a></h3>
190212
<li><a class="reference internal" href="#instructions">Instructions</a><ul>
191213
<li><a class="reference internal" href="#create-a-github-account">1. Create a GitHub account</a></li>
192214
<li><a class="reference internal" href="#get-the-pandas-source-code">2. Get the pandas source code</a></li>
193-
<li><a class="reference internal" href="#set-up-a-python-environment">3. Set up a Python environment</a><ul>
194-
<li><a class="reference internal" href="#a-python-environment-with-anaconda">3.a Python environment with Anaconda</a></li>
195-
<li><a class="reference internal" href="#b-python-environment-with-virtualenv-and-pip">3.b Python environment with virtualenv and pip</a></li>
196-
</ul>
197-
</li>
215+
<li><a class="reference internal" href="#set-up-a-python-environment">3. Set up a Python environment</a></li>
198216
<li><a class="reference internal" href="#compile-c-code-in-pandas">4. Compile C code in pandas</a></li>
199217
<li><a class="reference internal" href="#create-a-branch-and-start-coding">5. Create a branch and start coding</a></li>
200218
</ul>
@@ -236,7 +254,7 @@ <h3>Quick search</h3>
236254
&copy;.
237255

238256
|
239-
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.6</a>
257+
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.3</a>
240258
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
241259

242260
|

0 commit comments

Comments
 (0)