diff --git a/doc/source/_static/css/getting_started.css b/doc/source/_static/css/getting_started.css index bb24761cdb159..58d633245937d 100644 --- a/doc/source/_static/css/getting_started.css +++ b/doc/source/_static/css/getting_started.css @@ -66,6 +66,7 @@ } /* reference to user guide */ + .gs-torefguide { align-items: center; font-size: 0.9rem; @@ -129,69 +130,6 @@ ul.task-bullet > li > p:first-child { padding-left: 0.75rem; } -/* Getting started index page */ - -.intro-card { - background:#FFF; - border-radius:0; - padding: 30px 10px 10px 10px; - margin: 10px 0px; -} - -.intro-card .card-text { - margin:20px 0px; - /*min-height: 150px; */ -} - -.intro-card .card-img-top { - margin: 10px; -} - -.install-block { - padding-bottom: 30px; -} - -.install-card .card-header { - border: none; - background-color:white; - color: #150458; - font-size: 1.1rem; - font-weight: bold; - padding: 1rem 1rem 0rem 1rem; -} - -.install-card .card-footer { - border: none; - background-color:white; -} - -.install-card pre { - margin: 0 1em 1em 1em; -} - -.custom-button { - background-color:#DCDCDC; - border: none; - color: #484848; - text-align: center; - text-decoration: none; - display: inline-block; - font-size: 0.9rem; - border-radius: 0.5rem; - max-width: 120px; - padding: 0.5rem 0rem; -} - -.custom-button a { - color: #484848; -} - -.custom-button p { - margin-top: 0; - margin-bottom: 0rem; - color: #484848; -} - /* intro to tutorial collapsed cards */ .tutorial-accordion { diff --git a/doc/source/_static/css/pandas.css b/doc/source/_static/css/pandas.css index 43cd631890330..6ecae296a237e 100644 --- a/doc/source/_static/css/pandas.css +++ b/doc/source/_static/css/pandas.css @@ -1,15 +1,30 @@ /* Getting started index page */ .intro-card { - background: #fff; - border-radius: 0; - padding: 30px 10px 10px 10px; + background:#FFF; + border-radius:0; + padding: 10px 10px 10px 10px; margin: 10px 0px; } +.intro-card .card-title { + color: #150458; + font-size: 1.1rem; + font-weight: bold; +} + .intro-card .card-text { margin: 20px 0px; - /*min-height: 150px; */ +} + +.intro-card .card-img-top { + margin: 20px 10px 10px 10px; +} + +.intro-card .card-footer { + border: none; + background-color:white; + padding: 0rem 1.25rem; } .custom-button { @@ -23,6 +38,7 @@ border-radius: 0.5rem; max-width: 220px; padding: 0.5rem 0rem; + width: 100% } .custom-button a { @@ -33,4 +49,4 @@ margin-top: 0; margin-bottom: 0rem; color: #484848; -} +} \ No newline at end of file diff --git a/doc/source/conf.py b/doc/source/conf.py index a95cd4ab696f7..4936238e129c6 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -255,6 +255,9 @@ # Additional templates that should be rendered to pages, maps page names to # template names. +# Do not make scaled images a link +html_scaled_image_link = False + # Add redirect for previously existing API pages # each item is like `(from_old, to_new)` # To redirect a class and all its methods, see below diff --git a/doc/source/getting_started/index.rst b/doc/source/getting_started/index.rst index a2f8f79f22ae4..1551b62aa1b8a 100644 --- a/doc/source/getting_started/index.rst +++ b/doc/source/getting_started/index.rst @@ -11,82 +11,62 @@ Installation Before you can use pandas, you’ll need to get it installed. -.. raw:: html +.. container:: container -
-
-
-
-
- Working with conda? -
-
-

+ .. container:: row -Pandas is part of the `Anaconda `__ distribution and can be -installed with Anaconda or Miniconda: + .. container:: col-lg-6 col-md-6 col-sm-12 col-xs-12 d-flex install-block -.. raw:: html + .. container:: card intro-card shadow w-100 -

-
- -
-
-
-
-
- Prefer pip? -
-
-

+ .. container:: card-footer text-muted -Pandas can be installed via pip from `PyPI `__. + .. code-block:: bash -.. raw:: html + conda install pandas -

-
- -
-
-
-
-
- In-depth instructions? -
-
-

Installing a specific version? - Installing from source? - Check the advanced installation page.

+ Prefer pip? -.. container:: custom-button + Pandas can be installed via pip from `PyPI `__. - :ref:`Learn more ` + .. container:: card-footer text-muted -.. raw:: html + .. code-block:: bash -
-
-
-
-
+ pip install pandas + + .. container:: col-12 d-flex install-block + + .. container:: card intro-card shadow w-100 + + .. container:: card-body + + .. container:: card-title + + In-depth instructions? + + Installing a specific version? Installing from source? Check the advanced installation page. + + .. container:: custom-button + + :ref:`Learn more ` .. _gentle_intro: @@ -572,81 +552,84 @@ Currently working with other software for data manipulation in a tabular format? 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: -.. raw:: html +.. container:: container -
-
-
-
- R project logo -
-

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

+ .. container:: row -.. container:: custom-button + .. container:: col-lg-6 col-md-6 col-sm-6 col-xs-12 d-flex - :ref:`Learn more ` + .. container:: card text-center intro-card shadow -.. raw:: html + .. image:: ../_static/logo_r.svg + :class: card-img-top + :height: 72px + :alt: R project logo -
-
-
-
-
- SQL logo -
-

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

+ .. container:: card-body flex-fill -.. container:: custom-button + The `R programming language `_ provides the ``data.frame`` data + structure and multiple packages, such as `tidyverse `_ use and + extend ``data.frame`` s for convenient data handling functionalities similar to pandas. - :ref:`Learn more ` + .. container:: custom-button -.. raw:: html + :ref:`Learn more ` -
-
-
-
-
- STATA logo -
-

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 - in pandas.

+ .. container:: col-lg-6 col-md-6 col-sm-6 col-xs-12 d-flex -.. container:: custom-button + .. container:: card text-center intro-card shadow - :ref:`Learn more ` + .. image:: ../_static/logo_sql.svg + :class: card-img-top + :height: 72px + :alt: SQL logo -.. raw:: html + .. container:: card-body flex-fill -
-
-
-
-
- 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 - functions in pandas.

+ Already familiar to ``SELECT``, ``GROUP BY``, ``JOIN``,...? + Most of these SQL manipulations do have equivalents in pandas. -.. container:: custom-button + .. container:: custom-button - :ref:`Learn more ` + :ref:`Learn more ` -.. raw:: html + .. container:: col-lg-6 col-md-6 col-sm-6 col-xs-12 d-flex -
-
-
-
-
+ .. container:: card text-center intro-card shadow + + .. image:: ../_static/logo_stata.svg + :class: card-img-top + :height: 52px + :alt: Stata logo + + .. container:: card-body flex-fill + + 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 + in pandas. + + .. container:: custom-button + + :ref:`Learn more ` + + .. container:: col-lg-6 col-md-6 col-sm-6 col-xs-12 d-flex + + .. container:: card text-center intro-card shadow + + .. image:: ../_static/logo_sas.svg + :class: card-img-top + :height: 52px + :alt: SAS logo + + .. container:: card-body flex-fill + + The `SAS statistical software suite `_ + provides the ``data set`` corresponding to the pandas ``data.frame``. Also vectorized operations, + filtering, string processing operations,... from SAS have similar functions in pandas. + + .. container:: custom-button + + :ref:`Learn more ` Community tutorials ------------------- diff --git a/doc/source/index.rst.template b/doc/source/index.rst.template index 7eb25790f6a7a..11968af4f7539 100644 --- a/doc/source/index.rst.template +++ b/doc/source/index.rst.template @@ -23,82 +23,100 @@ pandas documentation easy-to-use data structures and data analysis tools for the `Python `__ programming language. -.. raw:: html - -
-
-
-
- getting started with pandas action icon -
-
Getting started
-

New to pandas? Check out the getting started guides. They - contain an introduction to pandas' main concepts and links to additional tutorials.

- -.. container:: custom-button - - :ref:`To the getting started guides` - -.. raw:: html - -
-
-
-
-
- pandas user guide action icon -
-
User guide
-

The user guide provides in-depth information on the - key concepts of pandas with useful background information and explanation.

- -.. container:: custom-button - - :ref:`To the user guide` - -.. raw:: html - -
-
-
-
-
- api of pandas action icon -
-
API reference
-

The reference guide contains a detailed description of - the pandas API. The reference describes how the methods work and which parameters can - be used. It assumes that you have an understanding of the key concepts.

- -.. container:: custom-button - - :ref:`To the reference guide` - -.. raw:: html - -
-
-
-
-
- contribute to pandas action icon -
-
Developer guide
-

Saw a typo in the documentation? Want to improve - existing functionalities? The contributing guidelines will guide - you through the process of improving pandas.

+.. container:: container + + .. container:: row + + .. container:: col-lg-6 col-md-6 col-sm-6 col-xs-12 d-flex + + .. container:: card text-center intro-card shadow + + .. image:: _static/index_getting_started.svg + :class: card-img-top + :height: 52px + :alt: getting started with pandas action icon + + .. container:: card-body flex-fill + + .. container:: card-title + + Getting started + + New to *pandas*? Check out the getting started guides. They + contain an introduction to *pandas'* main concepts and links to + additional tutorials. + + .. container:: custom-button + + :ref:`To the getting started guides` + + .. container:: col-lg-6 col-md-6 col-sm-6 col-xs-12 d-flex + + .. container:: card text-center intro-card shadow + + .. image:: _static/index_user_guide.svg + :class: card-img-top + :height: 52px + :alt: pandas user guide action icon + + .. container:: card-body flex-fill + + .. container:: card-title + + User guide + + The user guide provides in-depth information on the key concepts + of pandas with useful background information and explanation. -.. container:: custom-button + .. container:: custom-button - :ref:`To the development guide` + :ref:`To the user guide` + + .. container:: col-lg-6 col-md-6 col-sm-6 col-xs-12 d-flex + + .. container:: card text-center intro-card shadow + + .. image:: _static/index_api.svg + :class: card-img-top + :height: 52px + :alt: api of pandas action icon + + .. container:: card-body flex-fill + + .. container:: card-title + + API reference + + The reference guide contains a detailed description of the pandas API. The reference + describes how the methods work and which parameters can be used. It assumes that + you have an understanding of the key concepts. + + .. container:: custom-button + + :ref:`To the reference guide` + + .. container:: col-lg-6 col-md-6 col-sm-6 col-xs-12 d-flex + + .. container:: card text-center intro-card shadow + + .. image:: _static/index_contribute.svg + :class: card-img-top + :height: 52px + :alt: contribute to pandas action icon + + .. container:: card-body flex-fill + + .. container:: card-title + + Developer guide + + Saw a typo in the documentation? Want to improve + existing functionalities? The contributing guidelines will guide + you through the process of improving pandas. -.. raw:: html + .. container:: custom-button -
-
-
-
-
+ :ref:`To the development guide` {% if single_doc and single_doc.endswith('.rst') -%}