Skip to content

Commit 4f36b37

Browse files
kynankynan
committed
Rename index doc from contents to index
1 parent 783932c commit 4f36b37

17 files changed

+143
-143
lines changed

‎pandas/guide/_sources/contents.rst.txt renamed to ‎pandas/guide/_sources/index.rst.txt

File renamed without changes.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ pandas documentation.
167167
At the moment this documentation is under discussion, but it will soon be
168168
in its final state. You can find it here:
169169

170-
https://python-sprints.github.io/pandas/guide/contents.html
170+
https://python-sprints.github.io/pandas/guide/
171171

172172
There is a document on how to set up your computer for the sprint, which
173173
attendees are expected to follow before the sprint.

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -353,7 +353,7 @@ for `dict` and normal brackets for `tuple`):
353353

354354
In case where there are just a set of values allowed, list them in curly
355355
brackets and separated by commas (followed by a space). If the values are
356-
ordinal and they have an order, list them in this order. Otherwise, list
356+
ordinal and they have an order, list them in this order. Otherwuse, list
357357
the default value first, if there is one:
358358

359359
- {0, 10, 25}

‎pandas/guide/contents.html

Lines changed: 0 additions & 116 deletions
This file was deleted.

‎pandas/guide/genindex.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,12 +43,12 @@ <h1 id="index">Index</h1>
4343
</div>
4444
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
4545
<div class="sphinxsidebarwrapper">
46-
<p class="logo"><a href="contents.html">
46+
<p class="logo"><a href="index.html">
4747
<img class="logo" src="_static/logo.png" alt="Logo"/>
4848
</a></p><div class="relations">
4949
<h3>Related Topics</h3>
5050
<ul>
51-
<li><a href="contents.html">Documentation overview</a><ul>
51+
<li><a href="index.html">Documentation overview</a><ul>
5252
</ul></li>
5353
</ul>
5454
</div>

‎pandas/guide/index.html

Lines changed: 116 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,116 @@
1-
contents.html
1+
2+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4+
5+
<html xmlns="http://www.w3.org/1999/xhtml">
6+
<head>
7+
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
8+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9+
<title>Pandas documentation sprint &#8212; Python documentation</title>
10+
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
11+
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
12+
<script type="text/javascript" src="_static/documentation_options.js"></script>
13+
<script type="text/javascript" src="_static/jquery.js"></script>
14+
<script type="text/javascript" src="_static/underscore.js"></script>
15+
<script type="text/javascript" src="_static/doctools.js"></script>
16+
<link rel="index" title="Index" href="genindex.html" />
17+
<link rel="search" title="Search" href="search.html" />
18+
<link rel="next" title="Before the sprint: Set up instructions" href="pandas_setup.html" />
19+
20+
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
21+
22+
23+
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
24+
25+
</head><body>
26+
27+
28+
<div class="document">
29+
<div class="documentwrapper">
30+
<div class="bodywrapper">
31+
<div class="body" role="main">
32+
33+
<div class="section" id="pandas-documentation-sprint">
34+
<h1>Pandas documentation sprint<a class="headerlink" href="#pandas-documentation-sprint" title="Permalink to this headline"></a></h1>
35+
<p>The <a class="reference external" href="https://python-sprints.github.io/pandas/">pandas documentation sprint</a>
36+
is a worldwide event that will take place
37+
the 10th of March of 2018. During the sprint open source hackers will work
38+
on improving the <a class="reference external" href="https://pandas.pydata.org/pandas-docs/stable/api.html">pandas API documentation</a>.</p>
39+
<p>While most of pandas documentation is great, very extensive, and easy to follow,
40+
the API documentation could in many cases be better. Many of the <cite>DataFrame</cite>
41+
or <cite>Series</cite> methods for example, are documented with just a one liner
42+
summary. In some cases, the documented parameters are not up to date with
43+
the actual method parameters. And while docstrings use the numpy docstring
44+
convention, they could benefit from some pandas specific convention.</p>
45+
<p>There are around 1,300 API pages in pandas, meaning that the effort to fix,
46+
standardize and improve all the API documentation is huge. But the pandas
47+
user base is also huge. And Pythonistas are very active and well organized.
48+
So, we will work together from all around the world to take care of every
49+
single API, in a single day.</p>
50+
<p>This document provides all the necessary information to participate to the
51+
pandas documentation sprint.</p>
52+
<div class="toctree-wrapper compound">
53+
<ul>
54+
<li class="toctree-l1"><a class="reference internal" href="pandas_setup.html">Before the sprint: Set up instructions</a></li>
55+
<li class="toctree-l1"><a class="reference internal" href="pandas_docstring.html">pandas docstring guide</a></li>
56+
<li class="toctree-l1"><a class="reference internal" href="pandas_pr.html">Submitting your changes</a></li>
57+
</ul>
58+
</div>
59+
</div>
60+
61+
62+
</div>
63+
</div>
64+
</div>
65+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
66+
<div class="sphinxsidebarwrapper">
67+
<p class="logo"><a href="#">
68+
<img class="logo" src="_static/logo.png" alt="Logo"/>
69+
</a></p><div class="relations">
70+
<h3>Related Topics</h3>
71+
<ul>
72+
<li><a href="#">Documentation overview</a><ul>
73+
<li>Next: <a href="pandas_setup.html" title="next chapter">Before the sprint: Set up instructions</a></li>
74+
</ul></li>
75+
</ul>
76+
</div>
77+
<div role="note" aria-label="source link">
78+
<h3>This Page</h3>
79+
<ul class="this-page-menu">
80+
<li><a href="_sources/index.rst.txt"
81+
rel="nofollow">Show Source</a></li>
82+
</ul>
83+
</div>
84+
<div id="searchbox" style="display: none" role="search">
85+
<h3>Quick search</h3>
86+
<div class="searchformwrapper">
87+
<form class="search" action="search.html" method="get">
88+
<input type="text" name="q" />
89+
<input type="submit" value="Go" />
90+
<input type="hidden" name="check_keywords" value="yes" />
91+
<input type="hidden" name="area" value="default" />
92+
</form>
93+
</div>
94+
</div>
95+
<script type="text/javascript">$('#searchbox').show(0);</script>
96+
</div>
97+
</div>
98+
<div class="clearer"></div>
99+
</div>
100+
<div class="footer">
101+
&copy;.
102+
103+
|
104+
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.7.1</a>
105+
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
106+
107+
|
108+
<a href="_sources/index.rst.txt"
109+
rel="nofollow">Page source</a>
110+
</div>
111+
112+
113+
114+
115+
</body>
116+
</html>

‎pandas/guide/objects.inv

-8 Bytes
Binary file not shown.

‎pandas/guide/organizers.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ <h2>Getting ready for the sprint<a class="headerlink" href="#getting-ready-for-t
168168
pandas documentation.</p>
169169
<p>At the moment this documentation is under discussion, but it will soon be
170170
in its final state. You can find it here:</p>
171-
<p><a class="reference external" href="https://python-sprints.github.io/pandas/guide/contents.html">https://python-sprints.github.io/pandas/guide/contents.html</a></p>
171+
<p><a class="reference external" href="https://python-sprints.github.io/pandas/guide/">https://python-sprints.github.io/pandas/guide/</a></p>
172172
<p>There is a document on how to set up your computer for the sprint, which
173173
attendees are expected to follow before the sprint.</p>
174174
<p>Then there is a very detailed tutorial on how to write a docstring.</p>
@@ -232,10 +232,10 @@ <h2>Do not forget<a class="headerlink" href="#do-not-forget" title="Permalink to
232232
</div>
233233
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
234234
<div class="sphinxsidebarwrapper">
235-
<p class="logo"><a href="contents.html">
235+
<p class="logo"><a href="index.html">
236236
<img class="logo" src="_static/logo.png" alt="Logo"/>
237237
</a></p>
238-
<h3><a href="contents.html">Table Of Contents</a></h3>
238+
<h3><a href="index.html">Table Of Contents</a></h3>
239239
<ul>
240240
<li><a class="reference internal" href="#">Information for organizers</a><ul>
241241
<li><a class="reference internal" href="#the-venue">The venue</a></li>
@@ -251,7 +251,7 @@ <h3><a href="contents.html">Table Of Contents</a></h3>
251251
<div class="relations">
252252
<h3>Related Topics</h3>
253253
<ul>
254-
<li><a href="contents.html">Documentation overview</a><ul>
254+
<li><a href="index.html">Documentation overview</a><ul>
255255
</ul></li>
256256
</ul>
257257
</div>

‎pandas/guide/pandas_docstring.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -822,10 +822,10 @@ <h2>About docstrings and standards<a class="headerlink" href="#about-docstrings-
822822
</div>
823823
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
824824
<div class="sphinxsidebarwrapper">
825-
<p class="logo"><a href="contents.html">
825+
<p class="logo"><a href="index.html">
826826
<img class="logo" src="_static/logo.png" alt="Logo"/>
827827
</a></p>
828-
<h3><a href="contents.html">Table Of Contents</a></h3>
828+
<h3><a href="index.html">Table Of Contents</a></h3>
829829
<ul>
830830
<li><a class="reference internal" href="#">pandas docstring guide</a><ul>
831831
<li><a class="reference internal" href="#about-docstrings-and-standards">About docstrings and standards</a></li>
@@ -854,7 +854,7 @@ <h3><a href="contents.html">Table Of Contents</a></h3>
854854
<div class="relations">
855855
<h3>Related Topics</h3>
856856
<ul>
857-
<li><a href="contents.html">Documentation overview</a><ul>
857+
<li><a href="index.html">Documentation overview</a><ul>
858858
<li>Previous: <a href="pandas_setup.html" title="previous chapter">Before the sprint: Set up instructions</a></li>
859859
<li>Next: <a href="pandas_pr.html" title="next chapter">Submitting your changes</a></li>
860860
</ul></li>

‎pandas/guide/pandas_pr.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -201,10 +201,10 @@ <h3>Updating a pull request<a class="headerlink" href="#updating-a-pull-request"
201201
</div>
202202
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
203203
<div class="sphinxsidebarwrapper">
204-
<p class="logo"><a href="contents.html">
204+
<p class="logo"><a href="index.html">
205205
<img class="logo" src="_static/logo.png" alt="Logo"/>
206206
</a></p>
207-
<h3><a href="contents.html">Table Of Contents</a></h3>
207+
<h3><a href="index.html">Table Of Contents</a></h3>
208208
<ul>
209209
<li><a class="reference internal" href="#">Submitting your changes</a><ul>
210210
<li><a class="reference internal" href="#validate-that-your-docstring-does-not-have-technical-errors">1. Validate that your docstring does not have technical errors</a></li>
@@ -221,7 +221,7 @@ <h3><a href="contents.html">Table Of Contents</a></h3>
221221
<div class="relations">
222222
<h3>Related Topics</h3>
223223
<ul>
224-
<li><a href="contents.html">Documentation overview</a><ul>
224+
<li><a href="index.html">Documentation overview</a><ul>
225225
<li>Previous: <a href="pandas_docstring.html" title="previous chapter">pandas docstring guide</a></li>
226226
</ul></li>
227227
</ul>

‎pandas/guide/pandas_setup.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
<link rel="index" title="Index" href="genindex.html" />
1717
<link rel="search" title="Search" href="search.html" />
1818
<link rel="next" title="pandas docstring guide" href="pandas_docstring.html" />
19-
<link rel="prev" title="Pandas documentation sprint" href="contents.html" />
19+
<link rel="prev" title="Pandas documentation sprint" href="index.html" />
2020

2121
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
2222

@@ -224,10 +224,10 @@ <h3>5. Create a branch and start coding<a class="headerlink" href="#create-a-bra
224224
</div>
225225
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
226226
<div class="sphinxsidebarwrapper">
227-
<p class="logo"><a href="contents.html">
227+
<p class="logo"><a href="index.html">
228228
<img class="logo" src="_static/logo.png" alt="Logo"/>
229229
</a></p>
230-
<h3><a href="contents.html">Table Of Contents</a></h3>
230+
<h3><a href="index.html">Table Of Contents</a></h3>
231231
<ul>
232232
<li><a class="reference internal" href="#">Before the sprint: Set up instructions</a><ul>
233233
<li><a class="reference internal" href="#instructions">Instructions</a><ul>
@@ -244,8 +244,8 @@ <h3><a href="contents.html">Table Of Contents</a></h3>
244244
<div class="relations">
245245
<h3>Related Topics</h3>
246246
<ul>
247-
<li><a href="contents.html">Documentation overview</a><ul>
248-
<li>Previous: <a href="contents.html" title="previous chapter">Pandas documentation sprint</a></li>
247+
<li><a href="index.html">Documentation overview</a><ul>
248+
<li>Previous: <a href="index.html" title="previous chapter">Pandas documentation sprint</a></li>
249249
<li>Next: <a href="pandas_docstring.html" title="next chapter">pandas docstring guide</a></li>
250250
</ul></li>
251251
</ul>

0 commit comments

Comments
 (0)