Skip to content

Commit 592eb5e

Browse files
datapythonistagfyoung
authored andcommitted
DOC: Clean up of API doc sections (#24508)
Follow-up to gh-24462.
1 parent 100ffff commit 592eb5e

16 files changed

+139
-120
lines changed

Diff for: doc/source/api/extensions.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,9 @@
22

33
.. _api.extensions:
44

5+
==========
56
Extensions
6-
----------
7+
==========
78
.. currentmodule:: pandas
89

910
These are primarily intended for library authors looking to extend pandas

Diff for: doc/source/api/frame.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,9 @@
22

33
.. _api.dataframe:
44

5+
=========
56
DataFrame
6-
---------
7+
=========
78
.. currentmodule:: pandas
89

910
Constructor

Diff for: doc/source/api/general_functions.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,9 @@
22

33
.. _api.general_functions:
44

5+
=================
56
General functions
6-
-----------------
7+
=================
78
.. currentmodule:: pandas
89

910
Data manipulations

Diff for: doc/source/api/general_utility_functions.rst

+9-8
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,13 @@
22

33
.. _api.general_utility_functions:
44

5+
=========================
56
General utility functions
6-
-------------------------
7+
=========================
78
.. currentmodule:: pandas
89

910
Working with options
10-
~~~~~~~~~~~~~~~~~~~~
11+
--------------------
1112
.. autosummary::
1213
:toctree: generated/
1314

@@ -18,7 +19,7 @@ Working with options
1819
option_context
1920

2021
Testing functions
21-
~~~~~~~~~~~~~~~~~
22+
-----------------
2223
.. autosummary::
2324
:toctree: generated/
2425

@@ -27,7 +28,7 @@ Testing functions
2728
testing.assert_index_equal
2829

2930
Exceptions and warnings
30-
~~~~~~~~~~~~~~~~~~~~~~~
31+
-----------------------
3132
.. autosummary::
3233
:toctree: generated/
3334

@@ -41,7 +42,7 @@ Exceptions and warnings
4142
errors.UnsupportedFunctionCall
4243

4344
Data types related functionality
44-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
45+
--------------------------------
4546
.. autosummary::
4647
:toctree: generated/
4748

@@ -50,7 +51,7 @@ Data types related functionality
5051
api.types.pandas_dtype
5152

5253
Dtype introspection
53-
54+
~~~~~~~~~~~~~~~~~~~
5455
.. autosummary::
5556
:toctree: generated/
5657

@@ -77,7 +78,7 @@ Dtype introspection
7778
api.types.is_sparse
7879

7980
Iterable introspection
80-
81+
~~~~~~~~~~~~~~~~~~~~~~
8182
.. autosummary::
8283
:toctree: generated/
8384

@@ -88,7 +89,7 @@ Iterable introspection
8889
api.types.is_iterator
8990

9091
Scalar introspection
91-
92+
~~~~~~~~~~~~~~~~~~~~
9293
.. autosummary::
9394
:toctree: generated/
9495

Diff for: doc/source/api/groupby.rst

+5-4
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,15 @@
22

33
.. _api.groupby:
44

5+
=======
56
GroupBy
6-
-------
7+
=======
78
.. currentmodule:: pandas.core.groupby
89

910
GroupBy objects are returned by groupby calls: :func:`pandas.DataFrame.groupby`, :func:`pandas.Series.groupby`, etc.
1011

1112
Indexing, iteration
12-
~~~~~~~~~~~~~~~~~~~
13+
-------------------
1314
.. autosummary::
1415
:toctree: generated/
1516

@@ -29,7 +30,7 @@ Indexing, iteration
2930
.. currentmodule:: pandas.core.groupby
3031

3132
Function application
32-
~~~~~~~~~~~~~~~~~~~~
33+
--------------------
3334
.. autosummary::
3435
:toctree: generated/
3536

@@ -40,7 +41,7 @@ Function application
4041
GroupBy.pipe
4142

4243
Computations / Descriptive Stats
43-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
44+
--------------------------------
4445
.. autosummary::
4546
:toctree: generated/
4647

Diff for: doc/source/api/index.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
.. _api:
44

5-
*************
5+
=============
66
API Reference
7-
*************
7+
=============
88

99
This page gives an overview of all public pandas objects, functions and
1010
methods. All classes and functions exposed in ``pandas.*`` namespace are public.
@@ -27,7 +27,7 @@ public functions related to data types in pandas.
2727
series
2828
frame
2929
panel
30-
indices
30+
indexing
3131
scalars
3232
offset_frequency
3333
window

Diff for: doc/source/api/indices.rst renamed to doc/source/api/indexing.rst

+9-5
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
{{ header }}
22

3-
.. _api.index:
3+
.. _api.indexing:
4+
5+
========
6+
Indexing
7+
========
48

59
Index
610
-----
@@ -15,7 +19,7 @@ used before calling these methods directly.**
1519

1620
Index
1721

18-
Attributes
22+
Properties
1923
~~~~~~~~~~
2024
.. autosummary::
2125
:toctree: generated/
@@ -280,7 +284,7 @@ MultiIndex Constructors
280284
MultiIndex.from_product
281285
MultiIndex.from_frame
282286

283-
MultiIndex Attributes
287+
MultiIndex Properties
284288
~~~~~~~~~~~~~~~~~~~~~
285289
.. autosummary::
286290
:toctree: generated/
@@ -433,14 +437,14 @@ Conversion
433437
.. currentmodule:: pandas
434438

435439
PeriodIndex
436-
--------------
440+
-----------
437441
.. autosummary::
438442
:toctree: generated/
439443
:template: autosummary/class_without_autosummary.rst
440444

441445
PeriodIndex
442446

443-
Attributes
447+
Properties
444448
~~~~~~~~~~
445449
.. autosummary::
446450
:toctree: generated/

Diff for: doc/source/api/io.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,9 @@
22

33
.. _api.io:
44

5+
============
56
Input/Output
6-
------------
7+
============
78
.. currentmodule:: pandas
89

910
Pickling

0 commit comments

Comments
 (0)