Skip to content

Commit acb9474

Browse files
mroeschkeMatt Roeschke
authored andcommitted
DOC: Reorganize Getting Started documentation pages (pandas-dev#32389)
* DOC: Reorganize Getting Started documentation pages * Move some docs to user_guide, and adjust phrasing * Modify redirects, fix phrasing in getting_started * modify redirects Co-authored-by: Matt Roeschke <[email protected]>
1 parent f266817 commit acb9474

File tree

7 files changed

+38
-46
lines changed

7 files changed

+38
-46
lines changed

doc/redirects.csv

+3-3
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,10 @@ release,whatsnew/index
77

88
# getting started
99
install,getting_started/install
10-
10min,getting_started/10min
11-
basics,getting_started/basics
1210
comparison_with_r,getting_started/comparison/comparison_with_r
1311
comparison_with_sql,getting_started/comparison/comparison_with_sql
1412
comparison_with_sas,getting_started/comparison/comparison_with_sas
1513
comparison_with_stata,getting_started/comparison/comparison_with_stata
16-
dsintro,getting_started/dsintro
1714
overview,getting_started/overview
1815
tutorials,getting_started/tutorials
1916

@@ -38,6 +35,9 @@ text,user_guide/text
3835
timedeltas,user_guide/timedeltas
3936
timeseries,user_guide/timeseries
4037
visualization,user_guide/visualization
38+
10min,user_guide/10min
39+
basics,user_guide/basics
40+
dsintro,user_guide/dsintro
4141

4242
# development
4343
contributing,development/contributing

doc/source/getting_started/index.rst

+25-26
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,6 @@ Getting started
99
Installation
1010
------------
1111

12-
Before you can use pandas, you’ll need to get it installed.
13-
1412
.. raw:: html
1513

1614
<div class="container">
@@ -23,7 +21,7 @@ Before you can use pandas, you’ll need to get it installed.
2321
<div class="card-body">
2422
<p class="card-text">
2523

26-
Pandas is part of the `Anaconda <http://docs.continuum.io/anaconda/>`__ distribution and can be
24+
pandas is part of the `Anaconda <http://docs.continuum.io/anaconda/>`__ distribution and can be
2725
installed with Anaconda or Miniconda:
2826

2927
.. raw:: html
@@ -49,7 +47,7 @@ installed with Anaconda or Miniconda:
4947
<div class="card-body">
5048
<p class="card-text">
5149

52-
Pandas can be installed via pip from `PyPI <https://pypi.org/project/pandas>`__.
50+
pandas can be installed via pip from `PyPI <https://pypi.org/project/pandas>`__.
5351

5452
.. raw:: html
5553

@@ -103,7 +101,7 @@ Intro to pandas
103101
<div class="d-flex flex-row tutorial-card-header-1">
104102
<div class="d-flex flex-row tutorial-card-header-2">
105103
<button class="btn btn-dark btn-sm"></button>
106-
What kind of data does Pandas handle?
104+
What kind of data does pandas handle?
107105
</div>
108106
<span class="badge gs-badge-link">
109107

@@ -117,8 +115,8 @@ Intro to pandas
117115
<div id="collapseOne" class="collapse" data-parent="#accordion">
118116
<div class="card-body">
119117

120-
When working with tabular data, such as data stored in spreadsheets or databases, Pandas is the right tool for you. Pandas will help you
121-
to explore, clean and process your data. In Pandas, a data table is called a :class:`DataFrame`.
118+
When working with tabular data, such as data stored in spreadsheets or databases, pandas is the right tool for you. pandas will help you
119+
to explore, clean and process your data. In pandas, a data table is called a :class:`DataFrame`.
122120

123121
.. image:: ../_static/schemas/01_table_dataframe.svg
124122
:align: center
@@ -164,7 +162,7 @@ to explore, clean and process your data. In Pandas, a data table is called a :cl
164162
<div id="collapseTwo" class="collapse" data-parent="#accordion">
165163
<div class="card-body">
166164

167-
Pandas supports the integration with many file formats or data sources out of the box (csv, excel, sql, json, parquet,…). Importing data from each of these
165+
pandas supports the integration with many file formats or data sources out of the box (csv, excel, sql, json, parquet,…). Importing data from each of these
168166
data sources is provided by function with the prefix ``read_*``. Similarly, the ``to_*`` methods are used to store data.
169167

170168
.. image:: ../_static/schemas/02_io_readwrite.svg
@@ -212,7 +210,7 @@ data sources is provided by function with the prefix ``read_*``. Similarly, the
212210
<div class="card-body">
213211

214212
Selecting or filtering specific rows and/or columns? Filtering the data on a condition? Methods for slicing, selecting, and extracting the
215-
data you need are available in Pandas.
213+
data you need are available in pandas.
216214

217215
.. image:: ../_static/schemas/03_subset_columns_rows.svg
218216
:align: center
@@ -258,7 +256,7 @@ data you need are available in Pandas.
258256
<div id="collapseFour" class="collapse" data-parent="#accordion">
259257
<div class="card-body">
260258

261-
Pandas provides plotting your data out of the box, using the power of Matplotlib. You can pick the plot type (scatter, bar, boxplot,...)
259+
pandas provides plotting your data out of the box, using the power of Matplotlib. You can pick the plot type (scatter, bar, boxplot,...)
262260
corresponding to your data.
263261

264262
.. image:: ../_static/schemas/04_plot_overview.svg
@@ -492,7 +490,7 @@ Multiple tables can be concatenated both column wise as row wise and database-li
492490
<div id="collapseNine" class="collapse" data-parent="#accordion">
493491
<div class="card-body">
494492

495-
Pandas has great support for time series and has an extensive set of tools for working with dates, times, and time-indexed data.
493+
pandas has great support for time series and has an extensive set of tools for working with dates, times, and time-indexed data.
496494

497495
.. raw:: html
498496

@@ -535,7 +533,7 @@ Pandas has great support for time series and has an extensive set of tools for w
535533
<div id="collapseTen" class="collapse" data-parent="#accordion">
536534
<div class="card-body">
537535

538-
Data sets do not only contain numerical data. Pandas provides a wide range of functions to cleaning textual data and extract useful information from it.
536+
Data sets do not only contain numerical data. pandas provides a wide range of functions to cleaning textual data and extract useful information from it.
539537

540538
.. raw:: html
541539

@@ -568,9 +566,8 @@ Data sets do not only contain numerical data. Pandas provides a wide range of fu
568566
Coming from...
569567
--------------
570568

571-
Currently working with other software for data manipulation in a tabular format? You're probably familiar to typical
572-
data operations and know *what* to do with your tabular data, but lacking the syntax to execute these operations. Get to know
573-
the pandas syntax by looking for equivalents from the software you already know:
569+
Are you familiar with other software for manipulating tablular data? Learn
570+
the pandas-equivalent operations compared to software you already know:
574571

575572
.. raw:: html
576573

@@ -580,7 +577,7 @@ the pandas syntax by looking for equivalents from the software you already know:
580577
<div class="card text-center intro-card shadow">
581578
<img src="../_static/logo_r.svg" class="card-img-top" alt="R project logo" height="72">
582579
<div class="card-body flex-fill">
583-
<p class="card-text">The <a href="https://www.r-project.org/">R programming language</a> provides the <code>data.frame</code> data structure and multiple packages,
580+
<p class="card-text">The <a href="https://www.r-project.org/">R programming language</a> provides the <code>dataframe</code> data structure and multiple packages,
584581
such as <a href="https://www.tidyverse.org/">tidyverse</a> use and extend <code>data.frame</code>s for convenient data handling
585582
functionalities similar to pandas.</p>
586583

@@ -597,7 +594,7 @@ the pandas syntax by looking for equivalents from the software you already know:
597594
<div class="card text-center intro-card shadow">
598595
<img src="../_static/logo_sql.svg" class="card-img-top" alt="SQL logo" height="72">
599596
<div class="card-body flex-fill">
600-
<p class="card-text">Already familiar to <code>SELECT</code>, <code>GROUP BY</code>, <code>JOIN</code>,...?
597+
<p class="card-text">Already familiar to <code>SELECT</code>, <code>GROUP BY</code>, <code>JOIN</code>, etc.?
601598
Most of these SQL manipulations do have equivalents in pandas.</p>
602599

603600
.. container:: custom-button
@@ -615,7 +612,7 @@ the pandas syntax by looking for equivalents from the software you already know:
615612
<div class="card-body flex-fill">
616613
<p class="card-text">The <code>data set</code> included in the
617614
<a href="https://en.wikipedia.org/wiki/Stata">STATA</a> statistical software suite corresponds
618-
to the pandas <code>data.frame</code>. Many of the operations known from STATA have an equivalent
615+
to the pandas <code>dataframe</code>. Many of the operations known from STATA have an equivalent
619616
in pandas.</p>
620617

621618
.. container:: custom-button
@@ -632,8 +629,8 @@ the pandas syntax by looking for equivalents from the software you already know:
632629
<img src="../_static/logo_sas.svg" class="card-img-top" alt="SAS logo" height="52">
633630
<div class="card-body flex-fill">
634631
<p class="card-text">The <a href="https://en.wikipedia.org/wiki/SAS_(software)">SAS</a> statistical software suite
635-
also provides the <code>data set</code> corresponding to the pandas <code>data.frame</code>.
636-
Also vectorized operations, filtering, string processing operations,... from SAS have similar
632+
also provides the <code>data set</code> corresponding to the pandas <code>dataframe</code>.
633+
Also SAS vectorized operations, filtering, string processing operations, and more have similar
637634
functions in pandas.</p>
638635

639636
.. container:: custom-button
@@ -648,11 +645,16 @@ the pandas syntax by looking for equivalents from the software you already know:
648645
</div>
649646
</div>
650647

651-
Community tutorials
652-
-------------------
648+
Tutorials
649+
---------
650+
651+
For a quick overview of pandas functionality, see :ref:`10 Minutes to pandas<10min>`.
652+
653+
You can also reference the pandas `cheat sheet <https://pandas.pydata.org/Pandas_Cheat_Sheet.pdf>`_
654+
for a succinct guide for manipulating data with pandas.
653655

654656
The community produces a wide variety of tutorials available online. Some of the
655-
material is enlisted in the community contributed :ref:`tutorials`.
657+
material is enlisted in the community contributed :ref:`communitytutorials`.
656658

657659

658660
.. If you update this toctree, also update the manual toctree in the
@@ -664,9 +666,6 @@ material is enlisted in the community contributed :ref:`tutorials`.
664666

665667
install
666668
overview
667-
10min
668669
intro_tutorials/index
669-
basics
670-
dsintro
671670
comparison/index
672671
tutorials

doc/source/getting_started/tutorials.rst

+5-17
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,12 @@
1-
.. _tutorials:
1+
.. _communitytutorials:
22

33
{{ header }}
44

5-
*********
6-
Tutorials
7-
*********
5+
*******************
6+
Community Tutorials
7+
*******************
88

9-
This is a guide to many pandas tutorials, geared mainly for new users.
10-
11-
Internal guides
12-
===============
13-
14-
pandas' own :ref:`10 Minutes to pandas<10min>`.
15-
16-
More complex recipes are in the :ref:`Cookbook<cookbook>`.
17-
18-
A handy pandas `cheat sheet <https://pandas.pydata.org/Pandas_Cheat_Sheet.pdf>`_.
19-
20-
Community guides
21-
================
9+
This is a guide to many pandas tutorials by the community, geared mainly for new users.
2210

2311
pandas Cookbook by Julia Evans
2412
------------------------------

doc/source/user_guide/index.rst

+5
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ pandas approaches the problem, with many examples throughout.
1212

1313
Users brand-new to pandas should start with :ref:`10min`.
1414

15+
For a high level summary of the pandas fundamentals, see :ref:`dsintro` and :ref:`basics`.
16+
1517
Further information on any specific method can be obtained in the
1618
:ref:`api`.
1719

@@ -21,6 +23,9 @@ Further information on any specific method can be obtained in the
2123
.. toctree::
2224
:maxdepth: 2
2325

26+
10min
27+
dsintro
28+
basics
2429
io
2530
indexing
2631
advanced

0 commit comments

Comments
 (0)