diff --git a/doc/source/_static/css/pandas.css b/doc/source/_static/css/pandas.css new file mode 100644 index 0000000000000..84dbba823afa0 --- /dev/null +++ b/doc/source/_static/css/pandas.css @@ -0,0 +1,40 @@ +/* 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; +} + +.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: 220px; + padding: 0.5rem 0rem; +} + +.custom-button a { + color: #484848; +} + +.custom-button p { + margin-top: 0; + margin-bottom: 0rem; + color: #484848; +} diff --git a/doc/source/_static/index_api.svg b/doc/source/_static/index_api.svg new file mode 100644 index 0000000000000..70bf0d3504b1a --- /dev/null +++ b/doc/source/_static/index_api.svg @@ -0,0 +1,97 @@ + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + diff --git a/doc/source/_static/index_contribute.svg b/doc/source/_static/index_contribute.svg new file mode 100644 index 0000000000000..e86c3e9fd0b3e --- /dev/null +++ b/doc/source/_static/index_contribute.svg @@ -0,0 +1,76 @@ + + + + + + + + + + image/svg+xml + + + + + + + + + + + + diff --git a/doc/source/_static/index_getting_started.svg b/doc/source/_static/index_getting_started.svg new file mode 100644 index 0000000000000..d00e462427193 --- /dev/null +++ b/doc/source/_static/index_getting_started.svg @@ -0,0 +1,66 @@ + + + + + + + + + + image/svg+xml + + + + + + + + + diff --git a/doc/source/_static/index_user_guide.svg b/doc/source/_static/index_user_guide.svg new file mode 100644 index 0000000000000..a567103af5918 --- /dev/null +++ b/doc/source/_static/index_user_guide.svg @@ -0,0 +1,67 @@ + + + + + + + + + + image/svg+xml + + + + + + + + + diff --git a/doc/source/conf.py b/doc/source/conf.py index 481c03ab8f388..78b317456f720 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -229,6 +229,10 @@ # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ["_static"] +html_css_files = [ + "css/pandas.css", +] + # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. diff --git a/doc/source/index.rst.template b/doc/source/index.rst.template index 10705787dfedf..f3053452b4e6c 100644 --- a/doc/source/index.rst.template +++ b/doc/source/index.rst.template @@ -1,10 +1,12 @@ +:notoc: + .. pandas documentation master file, created by .. module:: pandas -********************************************* -pandas: powerful Python data analysis toolkit -********************************************* +******************** +pandas documentation +******************** **Date**: |today| **Version**: |version| @@ -21,7 +23,83 @@ pandas: powerful Python data analysis toolkit easy-to-use data structures and data analysis tools for the `Python `__ programming language. -See the :ref:`overview` for more detail about what's in the library. +.. 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:: custom-button + + :ref:`To the development guide` + +.. raw:: html + +
+
+
+
+
+ {% if single_doc and single_doc.endswith('.rst') -%} .. toctree:: @@ -50,68 +128,3 @@ See the :ref:`overview` for more detail about what's in the library. development/index whatsnew/index {% endif %} - -* :doc:`whatsnew/v1.0.0` -* :doc:`getting_started/index` - - * :doc:`getting_started/install` - * :doc:`getting_started/overview` - * :doc:`getting_started/10min` - * :doc:`getting_started/basics` - * :doc:`getting_started/dsintro` - * :doc:`getting_started/comparison/index` - * :doc:`getting_started/tutorials` - -* :doc:`user_guide/index` - - * :doc:`user_guide/io` - * :doc:`user_guide/indexing` - * :doc:`user_guide/advanced` - * :doc:`user_guide/merging` - * :doc:`user_guide/reshaping` - * :doc:`user_guide/text` - * :doc:`user_guide/missing_data` - * :doc:`user_guide/categorical` - * :doc:`user_guide/integer_na` - * :doc:`user_guide/boolean` - * :doc:`user_guide/visualization` - * :doc:`user_guide/computation` - * :doc:`user_guide/groupby` - * :doc:`user_guide/timeseries` - * :doc:`user_guide/timedeltas` - * :doc:`user_guide/style` - * :doc:`user_guide/options` - * :doc:`user_guide/enhancingperf` - * :doc:`user_guide/scale` - * :doc:`user_guide/sparse` - * :doc:`user_guide/gotchas` - * :doc:`user_guide/cookbook` - -* :doc:`ecosystem` -* :doc:`reference/index` - - * :doc:`reference/io` - * :doc:`reference/general_functions` - * :doc:`reference/series` - * :doc:`reference/frame` - * :doc:`reference/arrays` - * :doc:`reference/panel` - * :doc:`reference/indexing` - * :doc:`reference/offset_frequency` - * :doc:`reference/window` - * :doc:`reference/groupby` - * :doc:`reference/resampling` - * :doc:`reference/style` - * :doc:`reference/plotting` - * :doc:`reference/general_utility_functions` - * :doc:`reference/extensions` - -* :doc:`development/index` - - * :doc:`development/contributing` - * :doc:`development/code_style` - * :doc:`development/internals` - * :doc:`development/extending` - * :doc:`development/developer` - -* :doc:`whatsnew/index`