Skip to content

DOC: Clean up of API doc sections #24508

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 1 commit into from
Dec 31, 2018
Merged

DOC: Clean up of API doc sections #24508

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 2 additions & 1 deletion doc/source/api/extensions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@

.. _api.extensions:

==========
Extensions
----------
==========
.. currentmodule:: pandas

These are primarily intended for library authors looking to extend pandas
Expand Down
3 changes: 2 additions & 1 deletion doc/source/api/frame.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@

.. _api.dataframe:

=========
DataFrame
---------
=========
.. currentmodule:: pandas

Constructor
Expand Down
3 changes: 2 additions & 1 deletion doc/source/api/general_functions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@

.. _api.general_functions:

=================
General functions
-----------------
=================
.. currentmodule:: pandas

Data manipulations
Expand Down
17 changes: 9 additions & 8 deletions doc/source/api/general_utility_functions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,13 @@

.. _api.general_utility_functions:

=========================
General utility functions
-------------------------
=========================
.. currentmodule:: pandas

Working with options
~~~~~~~~~~~~~~~~~~~~
--------------------
.. autosummary::
:toctree: generated/

Expand All @@ -18,7 +19,7 @@ Working with options
option_context

Testing functions
~~~~~~~~~~~~~~~~~
-----------------
.. autosummary::
:toctree: generated/

Expand All @@ -27,7 +28,7 @@ Testing functions
testing.assert_index_equal

Exceptions and warnings
~~~~~~~~~~~~~~~~~~~~~~~
-----------------------
.. autosummary::
:toctree: generated/

Expand All @@ -41,7 +42,7 @@ Exceptions and warnings
errors.UnsupportedFunctionCall

Data types related functionality
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
--------------------------------
.. autosummary::
:toctree: generated/

Expand All @@ -50,7 +51,7 @@ Data types related functionality
api.types.pandas_dtype

Dtype introspection

~~~~~~~~~~~~~~~~~~~
.. autosummary::
:toctree: generated/

Expand All @@ -77,7 +78,7 @@ Dtype introspection
api.types.is_sparse

Iterable introspection

~~~~~~~~~~~~~~~~~~~~~~
.. autosummary::
:toctree: generated/

Expand All @@ -88,7 +89,7 @@ Iterable introspection
api.types.is_iterator

Scalar introspection

~~~~~~~~~~~~~~~~~~~~
.. autosummary::
:toctree: generated/

Expand Down
9 changes: 5 additions & 4 deletions doc/source/api/groupby.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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/

Expand All @@ -29,7 +30,7 @@ Indexing, iteration
.. currentmodule:: pandas.core.groupby

Function application
~~~~~~~~~~~~~~~~~~~~
--------------------
.. autosummary::
:toctree: generated/

Expand All @@ -40,7 +41,7 @@ Function application
GroupBy.pipe

Computations / Descriptive Stats
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
--------------------------------
.. autosummary::
:toctree: generated/

Expand Down
6 changes: 3 additions & 3 deletions doc/source/api/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -27,7 +27,7 @@ public functions related to data types in pandas.
series
frame
panel
indices
indexing
scalars
offset_frequency
window
Expand Down
14 changes: 9 additions & 5 deletions doc/source/api/indices.rst → doc/source/api/indexing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
{{ header }}

.. _api.index:
.. _api.indexing:

========
Indexing
========

Index
-----
Expand All @@ -15,7 +19,7 @@ used before calling these methods directly.**

Index

Attributes
Properties
~~~~~~~~~~
.. autosummary::
:toctree: generated/
Expand Down Expand Up @@ -280,7 +284,7 @@ MultiIndex Constructors
MultiIndex.from_product
MultiIndex.from_frame

MultiIndex Attributes
MultiIndex Properties
~~~~~~~~~~~~~~~~~~~~~
.. autosummary::
:toctree: generated/
Expand Down Expand Up @@ -433,14 +437,14 @@ Conversion
.. currentmodule:: pandas

PeriodIndex
--------------
-----------
.. autosummary::
:toctree: generated/
:template: autosummary/class_without_autosummary.rst

PeriodIndex

Attributes
Properties
~~~~~~~~~~
.. autosummary::
:toctree: generated/
Expand Down
3 changes: 2 additions & 1 deletion doc/source/api/io.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@

.. _api.io:

============
Input/Output
------------
============
.. currentmodule:: pandas

Pickling
Expand Down
Loading