Skip to content

Commit aee0c70

Browse files
Updating the pandas website with more information and a donation box, adding link to the event page from the doc home
1 parent f318648 commit aee0c70

File tree

8 files changed

+77
-26
lines changed

8 files changed

+77
-26
lines changed

pandas/assets/css/main.css

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,6 @@ p {
4141
}
4242

4343
ul li {
44-
font-weight: 700;
4544
margin-bottom: 10px;
4645
}
4746

@@ -617,3 +616,16 @@ ul li {
617616
.site-footer .social-block li a:hover, .site-footer .social-block li a:focus {
618617
opacity: 0.8;
619618
}
619+
#donate-box-outer {
620+
margin-bottom: 10px;
621+
}
622+
#donate-box-inner {
623+
margin: auto;
624+
width: 310px;
625+
text-align: center;
626+
border: 1px solid black;
627+
border-radius: 5px;
628+
}
629+
#donate-box-inner p {
630+
margin: 0;
631+
}

pandas/guide/_sources/contents.rst.txt

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,20 @@
22
Pandas documentation sprint
33
===========================
44

5-
The pandas documentation sprint is a worldwide event that will take place
5+
The `pandas documentation sprint <https://python-sprints.github.io/pandas/>`_
6+
is a worldwide event that will take place
67
the 10th of March of 2018. During the sprint open source hackers will work
78
on improving the `pandas API documentation
89
<https://pandas.pydata.org/pandas-docs/stable/api.html>`_.
910

1011
While most of pandas documentation is great, very extensive, and easy to follow,
1112
the API documentation could in many cases be better. Many of the `DataFrame`
12-
or `Series` methods for example, are documented with simply a one liner
13+
or `Series` methods for example, are documented with just a one liner
1314
summary. In some cases, the documented parameters are not up to date with
1415
the actual method parameters. And while docstrings use the numpy docstring
1516
convention, they could benefit from some pandas specific convention.
1617

17-
There are around 1,000 API pages in pandas, meaning that the effort to fix,
18+
There are around 1,300 API pages in pandas, meaning that the effort to fix,
1819
standardize and improve all the API documentation is huge. But the pandas
1920
user base is also huge. And Pythonistas are very active and well organized.
2021
So, we will work together from all around the world to take care of every

pandas/guide/_sources/pandas_setup.rst.txt

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,12 @@ Then, set the upstream remote, so you can fetch the updates from the pandas
6060
repository:
6161

6262
| ``git remote add upstream https://github.com/pandas-dev/pandas``
63+
64+
On how to fetch the latest updates from the pandas repository, follow the steps in `Syncing a Fork <https://help.github.com/articles/syncing-a-fork/>`_:
65+
| ``git fetch upstream``
66+
| ``git checkout master``
67+
| ``git merge upstream/master``
68+
6369

6470
3. Set up a Python environment
6571
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -91,8 +97,8 @@ Besides the Python `.py` files, pandas source code includes C/Cython files
9197
which need to be compiled in order to run the development version of pandas.
9298

9399
.. note::
94-
**Windows users**: to compile pandas, you need to install `Visual Studio 2017 <https://www.visualstudio.com/>`_. You need the Community edition as a minimum. Visual Studio Code does not support the required Build Tools and will not work.
95-
Select the Python development workload and the Native development tools option.
100+
**Windows users**: to compile pandas, you need to install `Visual Studio 2017 <https://www.visualstudio.com/>`_. You need Visual Studio Community 2017 (2.5GB download during installation) as a minimum. Visual Studio Code does not support the required Build Tools and will not work.
101+
Select the workload "Python development" and the option "Python native development tools" on the right side.
96102

97103
(Users of legacy Python 2.7 should install `Microsoft Visual C++ Compiler for Python 2.7 <https://www.microsoft.com/download/details.aspx?id=44266>`_ instead).
98104

pandas/guide/contents.html

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,16 +41,17 @@
4141

4242
<div class="section" id="pandas-documentation-sprint">
4343
<h1>Pandas documentation sprint<a class="headerlink" href="#pandas-documentation-sprint" title="Permalink to this headline"></a></h1>
44-
<p>The pandas documentation sprint is a worldwide event that will take place
44+
<p>The <a class="reference external" href="https://python-sprints.github.io/pandas/">pandas documentation sprint</a>
45+
is a worldwide event that will take place
4546
the 10th of March of 2018. During the sprint open source hackers will work
4647
on improving the <a class="reference external" href="https://pandas.pydata.org/pandas-docs/stable/api.html">pandas API documentation</a>.</p>
4748
<p>While most of pandas documentation is great, very extensive, and easy to follow,
4849
the API documentation could in many cases be better. Many of the <cite>DataFrame</cite>
49-
or <cite>Series</cite> methods for example, are documented with simply a one liner
50+
or <cite>Series</cite> methods for example, are documented with just a one liner
5051
summary. In some cases, the documented parameters are not up to date with
5152
the actual method parameters. And while docstrings use the numpy docstring
5253
convention, they could benefit from some pandas specific convention.</p>
53-
<p>There are around 1,000 API pages in pandas, meaning that the effort to fix,
54+
<p>There are around 1,300 API pages in pandas, meaning that the effort to fix,
5455
standardize and improve all the API documentation is huge. But the pandas
5556
user base is also huge. And Pythonistas are very active and well organized.
5657
So, we will work together from all around the world to take care of every

pandas/guide/pandas_setup.html

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,15 @@ <h3>2. Get the pandas source code<a class="headerlink" href="#get-the-pandas-sou
105105
<div class="line"><code class="docutils literal"><span class="pre">git</span> <span class="pre">remote</span> <span class="pre">add</span> <span class="pre">upstream</span> <span class="pre">https://github.com/pandas-dev/pandas</span></code></div>
106106
</div>
107107
</div></blockquote>
108+
<dl class="docutils">
109+
<dt>On how to fetch the latest updates from the pandas repository, follow the steps in <a class="reference external" href="https://help.github.com/articles/syncing-a-fork/">Syncing a Fork</a>:</dt>
110+
<dd><div class="first last line-block">
111+
<div class="line"><code class="docutils literal"><span class="pre">git</span> <span class="pre">fetch</span> <span class="pre">upstream</span></code></div>
112+
<div class="line"><code class="docutils literal"><span class="pre">git</span> <span class="pre">checkout</span> <span class="pre">master</span></code></div>
113+
<div class="line"><code class="docutils literal"><span class="pre">git</span> <span class="pre">merge</span> <span class="pre">upstream/master</span></code></div>
114+
</div>
115+
</dd>
116+
</dl>
108117
</div>
109118
<div class="section" id="set-up-a-python-environment">
110119
<h3>3. Set up a Python environment<a class="headerlink" href="#set-up-a-python-environment" title="Permalink to this headline"></a></h3>
@@ -155,8 +164,8 @@ <h3>4. Compile C code in pandas<a class="headerlink" href="#compile-c-code-in-pa
155164
which need to be compiled in order to run the development version of pandas.</p>
156165
<div class="admonition note">
157166
<p class="first admonition-title">Note</p>
158-
<p><strong>Windows users</strong>: to compile pandas, you need to install <a class="reference external" href="https://www.visualstudio.com/">Visual Studio 2017</a>. You need the Community edition as a minimum. Visual Studio Code does not support the required Build Tools and will not work.
159-
Select the Python development workload and the Native development tools option.</p>
167+
<p><strong>Windows users</strong>: to compile pandas, you need to install <a class="reference external" href="https://www.visualstudio.com/">Visual Studio 2017</a>. You need Visual Studio Community 2017 (2.5GB download during installation) as a minimum. Visual Studio Code does not support the required Build Tools and will not work.
168+
Select the workload “Python developmentand the option “Python native development tools” on the right side.</p>
160169
<p>(Users of legacy Python 2.7 should install <a class="reference external" href="https://www.microsoft.com/download/details.aspx?id=44266">Microsoft Visual C++ Compiler for Python 2.7</a> instead).</p>
161170
<p class="last">After the installation, run the following commands in Anaconda Prompt.</p>
162171
</div>

pandas/guide/searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pandas/guide/source/contents.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,20 @@
22
Pandas documentation sprint
33
===========================
44

5-
The pandas documentation sprint is a worldwide event that will take place
5+
The `pandas documentation sprint <https://python-sprints.github.io/pandas/>`_
6+
is a worldwide event that will take place
67
the 10th of March of 2018. During the sprint open source hackers will work
78
on improving the `pandas API documentation
89
<https://pandas.pydata.org/pandas-docs/stable/api.html>`_.
910

1011
While most of pandas documentation is great, very extensive, and easy to follow,
1112
the API documentation could in many cases be better. Many of the `DataFrame`
12-
or `Series` methods for example, are documented with simply a one liner
13+
or `Series` methods for example, are documented with just a one liner
1314
summary. In some cases, the documented parameters are not up to date with
1415
the actual method parameters. And while docstrings use the numpy docstring
1516
convention, they could benefit from some pandas specific convention.
1617

17-
There are around 1,000 API pages in pandas, meaning that the effort to fix,
18+
There are around 1,300 API pages in pandas, meaning that the effort to fix,
1819
standardize and improve all the API documentation is huge. But the pandas
1920
user base is also huge. And Pythonistas are very active and well organized.
2021
So, we will work together from all around the world to take care of every

pandas/index.html

Lines changed: 32 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -343,7 +343,7 @@
343343
#bio_ep a.footnote {
344344
color: #808080;
345345
}
346-
#bio_ep a.button {
346+
#bio_ep a.button, #donate-box-inner a.button {
347347
margin-top: 30px;
348348
-moz-box-shadow:inset 0px 1px 0px 0px #f5978e;
349349
-webkit-box-shadow:inset 0px 1px 0px 0px #f5978e;
@@ -370,7 +370,7 @@
370370
text-decoration:none;
371371
text-shadow:0px 1px 0px #810e05;
372372
}
373-
#bio_ep a.button:hover {
373+
#bio_ep a.button:hover, #donate-box-inner a.button:hover {
374374
background:-webkit-gradient(linear, left top, left bottom, color-stop(0.05, #c62d1f), color-stop(1, #f24537));
375375
background:-moz-linear-gradient(top, #c62d1f 5%, #f24537 100%);
376376
background:-webkit-linear-gradient(top, #c62d1f 5%, #f24537 100%);
@@ -380,7 +380,7 @@
380380
filter:progid:DXImageTransform.Microsoft.gradient(startColorstr='#c62d1f', endColorstr='#f24537',GradientType=0);
381381
background-color:#c62d1f;
382382
}
383-
#bio_ep a.button:active {
383+
#bio_ep a.button:active, #donate-box-inner a.button:active {
384384
position:relative;
385385
top:1px;
386386
}
@@ -494,10 +494,14 @@ <h3 class="section-title">About Us</h3>
494494
API documentation for the Series and DataFrame classes in a perfect state.
495495
</p>
496496

497-
<figure>
498-
<img alt="" class="img-responsive" src="assets/images/about-us.jpg">
499-
</figure>
500-
497+
<p>You can make pandas better, even if you can't join the sprint...</p>
498+
<div id="donate-box-outer">
499+
<div id="donate-box-inner">
500+
<p><img alt="" src="assets/images/pandas_logo_donation.png"/>
501+
<p><a class="button" href="https://www.flipcause.com/secure/cause_pdetails/MzA3OA==">MAKE A DONATION</a></p>
502+
<p><a class="footnote" href="http://pandas.pydata.org/donate.html">More info</a></p>
503+
</div>
504+
</div>
501505
</div><!-- /.col-sm-6 -->
502506

503507
<div class="col-sm-6">
@@ -510,15 +514,33 @@ <h3 class="section-title multiple-title">How does it work?</h3>
510514
there the venue, meeting time, etc.
511515
</p>
512516

513-
<p>Before the sprint, please make sure.</p>
517+
<h4>Before the sprint</h4>
514518

515519
<ul class="list-arrow-right">
516520
<li>Bring your own laptop</li>
517-
<li><a href="https://python-sprints.github.io/pandas/guide/pandas_setup.html">Set up your environment</a> before the sprint</li>
518-
<li>Make sure you RSVP for your chapter, number of attendees can be limited</li>
521+
<li><a href="https://python-sprints.github.io/pandas/guide/pandas_setup.html">Set up your environment</a></li>
522+
<li>Make sure you RSVP and get a spot before attending</li>
519523
<li>Join the <a href="https://gitter.im/py-sprints/pandas-doc">Gitter channel</a> of the sprint</li>
520524
</ul>
521525

526+
<figure>
527+
<img alt="" class="img-responsive" src="assets/images/about-us.jpg">
528+
</figure>
529+
530+
<h4>During the sprint</h4>
531+
532+
<ul class="list-arrow-right">
533+
<li>Go to the sprint location at the starting time</li>
534+
<li>Organizers will provide information, and there is <a href="https://python-sprints.github.io/pandas/guide/contents.html">documentation</a></li>
535+
<li>Discuss on the <a href="https://gitter.im/py-sprints/pandas-doc">Gitter channel</a></li>
536+
<li>Share your experience and photos in social networks using <b>#pandasSprint</b></li>
537+
<li>Thank the local sponsor for their support (in person and in social media)</li>
538+
<li>
539+
Be respectful, no form of harassment or discrimination is tolerated
540+
<ul><li style="list-style-type: none;">Read the full <a href="https://pydata.org/code-of-conduct.html">Code of conduct</a></li></ul>
541+
</li>
542+
</ul>
543+
522544
</div><!-- /.col-sm-6 -->
523545
</div><!-- /.row -->
524546
</div><!-- /.container -->
@@ -562,7 +584,6 @@ <h3>6<br>Hours</h3>
562584
<h3 class="section-title">Locations</h3>
563585
<address>
564586
<p>Click on the markers in the map for exact times and locations.</p>
565-
<p>More locations will be added in the future. If you want to organize a chapter, please get in touch at <a href="py.sprints@gmail.com">py.sprints@gmail.com</a>.</p>
566587
</address>
567588
</div>
568589
<div class="col-sm-9">

0 commit comments

Comments
 (0)