DOC: Clean up of API doc sections (pandas-dev#24508)

Follow-up to pandas-devgh-24462.
Pingviinituutti · Feb 28, 2019 · c8644a6 · c8644a6
1 parent 032a260
commit c8644a6
Show file tree

Hide file tree

Showing 16 changed files with 139 additions and 120 deletions.
diff --git a/doc/source/api/extensions.rst b/doc/source/api/extensions.rst
@@ -2,8 +2,9 @@
 
 .. _api.extensions:
 
+==========
 Extensions
-----------
+==========
 .. currentmodule:: pandas
 
 These are primarily intended for library authors looking to extend pandas

diff --git a/doc/source/api/frame.rst b/doc/source/api/frame.rst
@@ -2,8 +2,9 @@
 
 .. _api.dataframe:
 
+=========
 DataFrame
----------
+=========
 .. currentmodule:: pandas
 
 Constructor

diff --git a/doc/source/api/general_functions.rst b/doc/source/api/general_functions.rst
@@ -2,8 +2,9 @@
 
 .. _api.general_functions:
 
+=================
 General functions
------------------
+=================
 .. currentmodule:: pandas
 
 Data manipulations

diff --git a/doc/source/api/general_utility_functions.rst b/doc/source/api/general_utility_functions.rst
@@ -2,12 +2,13 @@
 
 .. _api.general_utility_functions:
 
+=========================
 General utility functions
--------------------------
+=========================
 .. currentmodule:: pandas
 
 Working with options
-~~~~~~~~~~~~~~~~~~~~
+--------------------
 .. autosummary::
    :toctree: generated/
 
@@ -18,7 +19,7 @@ Working with options
    option_context
 
 Testing functions
-~~~~~~~~~~~~~~~~~
+-----------------
 .. autosummary::
    :toctree: generated/
 
@@ -27,7 +28,7 @@ Testing functions
    testing.assert_index_equal
 
 Exceptions and warnings
-~~~~~~~~~~~~~~~~~~~~~~~
+-----------------------
 .. autosummary::
    :toctree: generated/
 
@@ -41,7 +42,7 @@ Exceptions and warnings
    errors.UnsupportedFunctionCall
 
 Data types related functionality
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+--------------------------------
 .. autosummary::
    :toctree: generated/
 
@@ -50,7 +51,7 @@ Data types related functionality
    api.types.pandas_dtype
 
 Dtype introspection
-
+~~~~~~~~~~~~~~~~~~~
 .. autosummary::
    :toctree: generated/
 
@@ -77,7 +78,7 @@ Dtype introspection
     api.types.is_sparse
 
 Iterable introspection
-
+~~~~~~~~~~~~~~~~~~~~~~
 .. autosummary::
    :toctree: generated/
 
@@ -88,7 +89,7 @@ Iterable introspection
     api.types.is_iterator
 
 Scalar introspection
-
+~~~~~~~~~~~~~~~~~~~~
 .. autosummary::
    :toctree: generated/
 

diff --git a/doc/source/api/groupby.rst b/doc/source/api/groupby.rst
@@ -2,14 +2,15 @@
 
 .. _api.groupby:
 
+=======
 GroupBy
--------
+=======
 .. currentmodule:: pandas.core.groupby
 
 GroupBy objects are returned by groupby calls: :func:`pandas.DataFrame.groupby`, :func:`pandas.Series.groupby`, etc.
 
 Indexing, iteration
-~~~~~~~~~~~~~~~~~~~
+-------------------
 .. autosummary::
    :toctree: generated/
 
@@ -29,7 +30,7 @@ Indexing, iteration
 .. currentmodule:: pandas.core.groupby
 
 Function application
-~~~~~~~~~~~~~~~~~~~~
+--------------------
 .. autosummary::
    :toctree: generated/
 
@@ -40,7 +41,7 @@ Function application
    GroupBy.pipe
 
 Computations / Descriptive Stats
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+--------------------------------
 .. autosummary::
    :toctree: generated/
 

diff --git a/doc/source/api/index.rst b/doc/source/api/index.rst
@@ -2,9 +2,9 @@
 
 .. _api:
 
-*************
+=============
 API Reference
-*************
+=============
 
 This page gives an overview of all public pandas objects, functions and
 methods. All classes and functions exposed in ``pandas.*`` namespace are public.
@@ -27,7 +27,7 @@ public functions related to data types in pandas.
    series
    frame
    panel
-   indices
+   indexing
    scalars
    offset_frequency
    window

diff --git a/doc/source/api/indices.rst → doc/source/api/indexing.rst b/doc/source/api/indices.rst → doc/source/api/indexing.rst
@@ -1,6 +1,10 @@
 {{ header }}
 
-.. _api.index:
+.. _api.indexing:
+
+========
+Indexing
+========
 
 Index
 -----
@@ -15,7 +19,7 @@ used before calling these methods directly.**
 
    Index
 
-Attributes
+Properties
 ~~~~~~~~~~
 .. autosummary::
    :toctree: generated/
@@ -280,7 +284,7 @@ MultiIndex Constructors
    MultiIndex.from_product
    MultiIndex.from_frame
 
-MultiIndex Attributes
+MultiIndex Properties
 ~~~~~~~~~~~~~~~~~~~~~
 .. autosummary::
    :toctree: generated/
@@ -433,14 +437,14 @@ Conversion
 .. currentmodule:: pandas
 
 PeriodIndex
---------------
+-----------
 .. autosummary::
    :toctree: generated/
    :template: autosummary/class_without_autosummary.rst
 
    PeriodIndex
 
-Attributes
+Properties
 ~~~~~~~~~~
 .. autosummary::
     :toctree: generated/

diff --git a/doc/source/api/io.rst b/doc/source/api/io.rst
@@ -2,8 +2,9 @@
 
 .. _api.io:
 
+============
 Input/Output
-------------
+============
 .. currentmodule:: pandas
 
 Pickling