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.

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
Next Next commit
Add first update to general doc page
  • Loading branch information
stijnvanhoey authored and jorisvandenbossche committed Jan 20, 2020
commit b35bd041c1bf6b10f6796a54a6ae60283f469e8b
43 changes: 33 additions & 10 deletions doc/source/index.rst.template
Original file line number Diff line number Diff line change
@@ -1,27 +1,50 @@
:notoc:

.. pandas documentation master file, created by

.. module:: pandas

*********************************************
pandas: powerful Python data analysis toolkit
*********************************************
********************
pandas documentation
********************

**Date**: |today| **Version**: |version|

**Download documentation**: `PDF Version <pandas.pdf>`__ | `Zipped HTML <pandas.zip>`__

**Useful links**:
`Binary Installers <https://pypi.org/project/pandas>`__ |
`Source Repository <https://github.com/pandas-dev/pandas>`__ |
:mod:`pandas` is an open source, BSD-licensed library providing high-performance,
easy-to-use data structures and data analysis tools for the `Python <https://www.python.org/>`__
programming language.

----------------------------------
How the documentation is organized
----------------------------------

Pandas has a lot of documentation. A high-level overview of how it’s organized will help you know where to look for certain things:

TODO -> 4 blokken (cfr. coming from)

- :ref:`getting_started` contains a :ref:`_gentle_intro` first introduction to some of the main pandas core concepts. Furthermore, it contains an overview of
:ref:`community_guides` community provided tutorials.
- :ref:`user_guide` provides in-depth information on the key concepts of pandas with useful background information and explanation.
- :ref:`api` contains a technical reference of the pandas API and available functionalities. The reference describes how the methods work and which parameters
can be used. It assumes that you have an understanding of the key concepts.
- Saw a typo in the documentation? Want to improve existing functionalities. The :ref:`development` guidelines will guide you through the process of setting up a development environment.

------------
Getting help
------------

`Issues & Ideas <https://github.com/pandas-dev/pandas/issues>`__ |
`Q&A Support <https://stackoverflow.com/questions/tagged/pandas>`__ |
`Mailing List <https://groups.google.com/forum/#!forum/pydata>`__

:mod:`pandas` is an open source, BSD-licensed library providing high-performance,
easy-to-use data structures and data analysis tools for the `Python <https://www.python.org/>`__
programming language.
-----------------------------
pandas documentation overview
-----------------------------

See the :ref:`overview` for more detail about what's in the library.
`Binary Installers <https://pypi.org/project/pandas>`__ |
`Source Repository <https://github.com/pandas-dev/pandas>`__ |

{% if single_doc and single_doc.endswith('.rst') -%}
.. toctree::
Expand Down