From 36ebffd074209ec18735d7ea0190ca006771f1f1 Mon Sep 17 00:00:00 2001 From: Matt Roeschke Date: Sun, 1 Mar 2020 23:17:34 -0800 Subject: [PATCH 1/4] DOC: Reorganize Getting Started documentation pages --- doc/source/getting_started/index.rst | 53 ++++++++++++------------ doc/source/getting_started/tutorials.rst | 22 +++------- doc/source/user_guide/index.rst | 2 + 3 files changed, 33 insertions(+), 44 deletions(-) diff --git a/doc/source/getting_started/index.rst b/doc/source/getting_started/index.rst index a2f8f79f22ae4..b7d2182ef253f 100644 --- a/doc/source/getting_started/index.rst +++ b/doc/source/getting_started/index.rst @@ -3,14 +3,12 @@ .. _getting_started: =============== -Getting started +Getting Started =============== Installation ------------ -Before you can use pandas, you’ll need to get it installed. - .. raw:: html
@@ -23,7 +21,7 @@ Before you can use pandas, you’ll need to get it installed.

-Pandas is part of the `Anaconda `__ distribution and can be +pandas is part of the `Anaconda `__ distribution and can be installed with Anaconda or Miniconda: .. raw:: html @@ -49,7 +47,7 @@ installed with Anaconda or Miniconda:

-Pandas can be installed via pip from `PyPI `__. +pandas can be installed via pip from `PyPI `__. .. raw:: html @@ -103,7 +101,7 @@ Intro to pandas

- What kind of data does Pandas handle? + What kind of data does pandas handle?
@@ -117,8 +115,8 @@ Intro to pandas
-When working with tabular data, such as data stored in spreadsheets or databases, Pandas is the right tool for you. Pandas will help you -to explore, clean and process your data. In Pandas, a data table is called a :class:`DataFrame`. +When working with tabular data, such as data stored in spreadsheets or databases, pandas is the right tool for you. pandas will help you +to explore, clean and process your data. In pandas, a data table is called a :class:`DataFrame`. .. image:: ../_static/schemas/01_table_dataframe.svg :align: center @@ -164,7 +162,7 @@ to explore, clean and process your data. In Pandas, a data table is called a :cl
-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 +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 data sources is provided by function with the prefix ``read_*``. Similarly, the ``to_*`` methods are used to store data. .. image:: ../_static/schemas/02_io_readwrite.svg @@ -212,7 +210,7 @@ data sources is provided by function with the prefix ``read_*``. Similarly, the
Selecting or filtering specific rows and/or columns? Filtering the data on a condition? Methods for slicing, selecting, and extracting the -data you need are available in Pandas. +data you need are available in pandas. .. image:: ../_static/schemas/03_subset_columns_rows.svg :align: center @@ -258,7 +256,7 @@ data you need are available in Pandas.
-Pandas provides plotting your data out of the box, using the power of Matplotlib. You can pick the plot type (scatter, bar, boxplot,...) +pandas provides plotting your data out of the box, using the power of Matplotlib. You can pick the plot type (scatter, bar, boxplot,...) corresponding to your data. .. 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
-Pandas has great support for time series and has an extensive set of tools for working with dates, times, and time-indexed data. +pandas has great support for time series and has an extensive set of tools for working with dates, times, and time-indexed data. .. raw:: html @@ -535,7 +533,7 @@ Pandas has great support for time series and has an extensive set of tools for w
-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. +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. .. raw:: html @@ -568,9 +566,8 @@ Data sets do not only contain numerical data. Pandas provides a wide range of fu Coming from... -------------- -Currently working with other software for data manipulation in a tabular format? You're probably familiar to typical -data operations and know *what* to do with your tabular data, but lacking the syntax to execute these operations. Get to know -the pandas syntax by looking for equivalents from the software you already know: +Are you familiar with other software for manipulating tablular data? Learn +the pandas-equivalent operations compared to software you already know: .. raw:: html @@ -580,7 +577,7 @@ the pandas syntax by looking for equivalents from the software you already know:
R project logo
-

The R programming language provides the data.frame data structure and multiple packages, +

The R programming language provides the dataframe data structure and multiple packages, such as tidyverse use and extend data.frames for convenient data handling functionalities similar to pandas.

@@ -597,7 +594,7 @@ the pandas syntax by looking for equivalents from the software you already know:
SQL logo
-

Already familiar to SELECT, GROUP BY, JOIN,...? +

Already familiar to SELECT, GROUP BY, JOIN, etc.? Most of these SQL manipulations do have equivalents in pandas.

.. container:: custom-button @@ -615,7 +612,7 @@ the pandas syntax by looking for equivalents from the software you already know:

The data set included in the STATA statistical software suite corresponds - to the pandas data.frame. Many of the operations known from STATA have an equivalent + to the pandas dataframe. Many of the operations known from STATA have an equivalent in pandas.

.. container:: custom-button @@ -632,8 +629,8 @@ the pandas syntax by looking for equivalents from the software you already know: SAS logo

The SAS statistical software suite - also provides the data set corresponding to the pandas data.frame. - Also vectorized operations, filtering, string processing operations,... from SAS have similar + also provides the data set corresponding to the pandas dataframe. + Also vectorized operations, filtering, string processing operations, and more from SAS have similar functions in pandas.

.. container:: custom-button @@ -648,11 +645,16 @@ the pandas syntax by looking for equivalents from the software you already know:
-Community tutorials -------------------- +Tutorials +--------- + +For a quick introduction to pandas, see :ref:`10 Minutes to pandas<10min>`. + +You can also reference the pandas `cheat sheet `_ +for a succinct guide for manipulating data with pandas. The community produces a wide variety of tutorials available online. Some of the -material is enlisted in the community contributed :ref:`tutorials`. +material is enlisted in the community contributed :ref:`communitytutorials`. .. 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`. install overview - 10min intro_tutorials/index - basics - dsintro comparison/index tutorials diff --git a/doc/source/getting_started/tutorials.rst b/doc/source/getting_started/tutorials.rst index 434d791474807..fce4aa4beba60 100644 --- a/doc/source/getting_started/tutorials.rst +++ b/doc/source/getting_started/tutorials.rst @@ -1,24 +1,12 @@ -.. _tutorials: +.. _communitytutorials: {{ header }} -********* -Tutorials -********* +******************* +Community Tutorials +******************* -This is a guide to many pandas tutorials, geared mainly for new users. - -Internal guides -=============== - -pandas' own :ref:`10 Minutes to pandas<10min>`. - -More complex recipes are in the :ref:`Cookbook`. - -A handy pandas `cheat sheet `_. - -Community guides -================ +This is a guide to many pandas tutorials by the community, geared mainly for new users. pandas Cookbook by Julia Evans ------------------------------ diff --git a/doc/source/user_guide/index.rst b/doc/source/user_guide/index.rst index 30b1c0b4eac0d..5a2eb1acfb7ba 100644 --- a/doc/source/user_guide/index.rst +++ b/doc/source/user_guide/index.rst @@ -12,6 +12,8 @@ pandas approaches the problem, with many examples throughout. Users brand-new to pandas should start with :ref:`10min`. +For a high level summary of the pandas fundamentals, see :ref:`dsintro` and :ref:`basics`. + Further information on any specific method can be obtained in the :ref:`api`. From ac68cd28ce86dfea610d1cdbfd2ef96740f3dc42 Mon Sep 17 00:00:00 2001 From: Matt Roeschke Date: Mon, 2 Mar 2020 17:55:24 -0800 Subject: [PATCH 2/4] Move some docs to user_guide, and adjust phrasing --- doc/source/getting_started/index.rst | 2 +- doc/source/{getting_started => user_guide}/10min.rst | 0 doc/source/{getting_started => user_guide}/basics.rst | 0 doc/source/{getting_started => user_guide}/dsintro.rst | 0 doc/source/user_guide/index.rst | 3 +++ 5 files changed, 4 insertions(+), 1 deletion(-) rename doc/source/{getting_started => user_guide}/10min.rst (100%) rename doc/source/{getting_started => user_guide}/basics.rst (100%) rename doc/source/{getting_started => user_guide}/dsintro.rst (100%) diff --git a/doc/source/getting_started/index.rst b/doc/source/getting_started/index.rst index b7d2182ef253f..62cc849ee2af4 100644 --- a/doc/source/getting_started/index.rst +++ b/doc/source/getting_started/index.rst @@ -648,7 +648,7 @@ the pandas-equivalent operations compared to software you already know: Tutorials --------- -For a quick introduction to pandas, see :ref:`10 Minutes to pandas<10min>`. +For a quick overview of pandas functionality, see :ref:`10 Minutes to pandas<10min>`. You can also reference the pandas `cheat sheet `_ for a succinct guide for manipulating data with pandas. diff --git a/doc/source/getting_started/10min.rst b/doc/source/user_guide/10min.rst similarity index 100% rename from doc/source/getting_started/10min.rst rename to doc/source/user_guide/10min.rst diff --git a/doc/source/getting_started/basics.rst b/doc/source/user_guide/basics.rst similarity index 100% rename from doc/source/getting_started/basics.rst rename to doc/source/user_guide/basics.rst diff --git a/doc/source/getting_started/dsintro.rst b/doc/source/user_guide/dsintro.rst similarity index 100% rename from doc/source/getting_started/dsintro.rst rename to doc/source/user_guide/dsintro.rst diff --git a/doc/source/user_guide/index.rst b/doc/source/user_guide/index.rst index 5a2eb1acfb7ba..8226e72779588 100644 --- a/doc/source/user_guide/index.rst +++ b/doc/source/user_guide/index.rst @@ -23,6 +23,9 @@ Further information on any specific method can be obtained in the .. toctree:: :maxdepth: 2 + 10min + dsintro + basics io indexing advanced From 72449766727ea5d755e2267d56bfb7dbbbb83e97 Mon Sep 17 00:00:00 2001 From: Matt Roeschke Date: Tue, 3 Mar 2020 17:47:30 -0800 Subject: [PATCH 3/4] Modify redirects, fix phrasing in getting_started --- doc/redirects.csv | 6 +++--- doc/source/getting_started/index.rst | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/redirects.csv b/doc/redirects.csv index ef93955c14fe6..2db7dafa8c6a4 100644 --- a/doc/redirects.csv +++ b/doc/redirects.csv @@ -7,13 +7,10 @@ release,whatsnew/index # getting started install,getting_started/install -10min,getting_started/10min -basics,getting_started/basics comparison_with_r,getting_started/comparison/comparison_with_r comparison_with_sql,getting_started/comparison/comparison_with_sql comparison_with_sas,getting_started/comparison/comparison_with_sas comparison_with_stata,getting_started/comparison/comparison_with_stata -dsintro,getting_started/dsintro overview,getting_started/overview tutorials,getting_started/tutorials @@ -38,6 +35,9 @@ text,user_guide/text timedeltas,user_guide/timedeltas timeseries,user_guide/timeseries visualization,user_guide/visualization +getting_started/10min,user_guide/10min +getting_started/10min,user_guide/basics +getting_started/10min,user_guide/dsintro # development contributing,development/contributing diff --git a/doc/source/getting_started/index.rst b/doc/source/getting_started/index.rst index 62cc849ee2af4..9ac8c58e1d8f2 100644 --- a/doc/source/getting_started/index.rst +++ b/doc/source/getting_started/index.rst @@ -3,7 +3,7 @@ .. _getting_started: =============== -Getting Started +Getting started =============== Installation @@ -630,7 +630,7 @@ the pandas-equivalent operations compared to software you already know:

The SAS statistical software suite also provides the data set corresponding to the pandas dataframe. - Also vectorized operations, filtering, string processing operations, and more from SAS have similar + Also SAS vectorized operations, filtering, string processing operations, and more have similar functions in pandas.

.. container:: custom-button From 1abd2f20e5c2a9830012d0e1860358173447ff83 Mon Sep 17 00:00:00 2001 From: Matt Roeschke Date: Thu, 5 Mar 2020 18:02:02 -0800 Subject: [PATCH 4/4] modify redirects --- doc/redirects.csv | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/redirects.csv b/doc/redirects.csv index 2db7dafa8c6a4..a6db4dd975a35 100644 --- a/doc/redirects.csv +++ b/doc/redirects.csv @@ -35,9 +35,9 @@ text,user_guide/text timedeltas,user_guide/timedeltas timeseries,user_guide/timeseries visualization,user_guide/visualization -getting_started/10min,user_guide/10min -getting_started/10min,user_guide/basics -getting_started/10min,user_guide/dsintro +10min,user_guide/10min +basics,user_guide/basics +dsintro,user_guide/dsintro # development contributing,development/contributing