Skip to content

DOC: replace long table of contents on home page with main links #31148

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Jan 27, 2020
Merged

DOC: replace long table of contents on home page with main links #31148

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
b35bd04
Add first update to general doc page
stijnvanhoey Jan 13, 2020
2de0f13
add boxes and css from getting started
stijnvanhoey Jan 20, 2020
9b189ea
update content of cards
jorisvandenbossche Jan 20, 2020
e72cd7c
remove manual table of contents
jorisvandenbossche Jan 20, 2020
c15c1c1
Add icons to cards
stijnvanhoey Jan 20, 2020
1ea7971
Fix relative paths
stijnvanhoey Jan 20, 2020
02d609c
Apply suggestions from code review
jorisvandenbossche Jan 24, 2020
9cf0fed
Merge remote-tracking branch 'upstream/master' into doc-home-page
jorisvandenbossche Jan 24, 2020
babdb71
fixups
jorisvandenbossche Jan 24, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions doc/source/_static/css/pandas.css
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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;
}
4 changes: 4 additions & 0 deletions doc/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -230,6 +230,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.
Expand Down
149 changes: 80 additions & 69 deletions doc/source/index.rst.template
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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|

Expand All @@ -21,7 +23,81 @@ pandas: powerful Python data analysis toolkit
easy-to-use data structures and data analysis tools for the `Python <https://www.python.org/>`__
programming language.

See the :ref:`overview` for more detail about what's in the library.
.. raw:: html

<div class="container">
<div class="row">
<div class="col-lg-6 col-md-6 col-sm-6 col-xs-12 d-flex">
<div class="card text-center intro-card shadow">
<div class="card-body flex-fill">
<h5 class="card-title">Getting started</h5>
<p class="card-text">New to <em>pandas</em>? Check out the getting started guides. They
contain a first introduction to some of the main <em>pandas</em> concepts. Furthermore,
it contains an overview of community provided tutorials.</p>

.. container:: custom-button

:ref:`To the getting started guides<getting_started>`

.. raw:: html

</div>
</div>
</div>
<div class="col-lg-6 col-md-6 col-sm-6 col-xs-12 d-flex">
<div class="card text-center intro-card shadow">
<div class="card-body flex-fill">
<h5 class="card-title">User guide</h5>
<p class="card-text">The user guide provides in-depth information on the
key concepts of pandas with useful background information and explanation.</p>

.. container:: custom-button

:ref:`To the user guide<user_guide>`

.. raw:: html

</div>
</div>
</div>
<div class="col-lg-6 col-md-6 col-sm-6 col-xs-12 d-flex">
<div class="card text-center intro-card shadow">
<div class="card-body flex-fill">
<h5 class="card-title">API reference</h5>
<p class="card-text">The reference guide contains a detailed overview of
all functionalities in 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.</p>

.. container:: custom-button

:ref:`To the reference guide<api>`

.. raw:: html

</div>
</div>
</div>
<div class="col-lg-6 col-md-6 col-sm-6 col-xs-12 d-flex">
<div class="card text-center intro-card shadow">
<div class="card-body flex-fill">
<h5 class="card-title">Developer guide</h5>
<p class="card-text">Saw a typo in the documentation? Want to improve
existing functionalities? The contributing guidelines will guide
you through the process of setting up a development environment.</p>

.. container:: custom-button

:ref:`To the development guide<development>`

.. raw:: html

</div>
</div>
</div>
</div>
</div>


{% if single_doc and single_doc.endswith('.rst') -%}
.. toctree::
Expand Down Expand Up @@ -50,68 +126,3 @@ See the :ref:`overview` for more detail about what's in the library.
development/index
whatsnew/index
{% endif %}

* :doc:`whatsnew/v1.1.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`