forked from pandas-dev/pandas
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.rst.template
143 lines (110 loc) · 3.73 KB
/
index.rst.template
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
:notoc:
.. pandas documentation master file, created by
.. module:: pandas
********************
pandas documentation
********************
**Date**: |today| **Version**: |version|
**Download documentation**: `Zipped HTML <pandas.zip>`__
**Previous versions**: Documentation of previous pandas versions is available at
`pandas.pydata.org <https://pandas.pydata.org/>`__.
**Useful links**:
`Binary Installers <https://pypi.org/project/pandas>`__ |
`Source Repository <https://github.com/pandas-dev/pandas>`__ |
`Issues & Ideas <https://github.com/pandas-dev/pandas/issues>`__ |
`Q&A Support <https://stackoverflow.com/questions/tagged/pandas>`__ |
`Mailing List <https://groups.google.com/g/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.
{% if not single_doc or single_doc == "index.rst" -%}
.. grid:: 1 2 2 2
:gutter: 4
:padding: 2 2 0 0
:class-container: sd-text-center
.. grid-item-card:: Getting started
:img-top: _static/index_getting_started.svg
:class-card: intro-card
:shadow: md
New to *pandas*? Check out the getting started guides. They contain an
introduction to *pandas'* main concepts and links to additional tutorials.
+++
.. button-ref:: getting_started
:ref-type: ref
:click-parent:
:color: secondary
:expand:
To the getting started guides
.. grid-item-card:: User guide
:img-top: _static/index_user_guide.svg
:class-card: intro-card
:shadow: md
The user guide provides in-depth information on the
key concepts of pandas with useful background information and explanation.
+++
.. button-ref:: user_guide
:ref-type: ref
:click-parent:
:color: secondary
:expand:
To the user guide
.. grid-item-card:: API reference
:img-top: _static/index_api.svg
:class-card: intro-card
:shadow: md
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.
+++
.. button-ref:: api
:ref-type: ref
:click-parent:
:color: secondary
:expand:
To the reference guide
.. grid-item-card:: Developer guide
:img-top: _static/index_contribute.svg
:class-card: intro-card
:shadow: md
Saw a typo in the documentation? Want to improve
existing functionalities? The contributing guidelines will guide
you through the process of improving pandas.
+++
.. button-ref:: development
:ref-type: ref
:click-parent:
:color: secondary
:expand:
To the development guide
{% endif %}
{% if single_doc and single_doc.endswith('.rst') -%}
.. toctree::
:maxdepth: 3
:titlesonly:
{{ single_doc[:-4] }}
{% elif single_doc and single_doc.count('.') <= 1 %}
.. autosummary::
:toctree: reference/api/
{{ single_doc }}
{% elif single_doc %}
.. autosummary::
:toctree: reference/api/
:template: autosummary/accessor_method.rst
{{ single_doc }}
{% else -%}
.. toctree::
:maxdepth: 3
:hidden:
:titlesonly:
{% endif %}
{% if not single_doc %}
getting_started/index
user_guide/index
{% endif -%}
{% if include_api -%}
reference/index
{% endif -%}
{% if not single_doc -%}
development/index
whatsnew/index
{% endif %}