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.

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
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -2,8 +2,9 @@

.. _api.extensions:

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

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

.. _api.dataframe:

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

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

.. _api.general_functions:

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

Data manipulations
17 changes: 9 additions & 8 deletions doc/source/api/general_utility_functions.rst
Original file line number Diff line number Diff line change
@@ -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/

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

6 changes: 3 additions & 3 deletions doc/source/api/index.rst
Original file line number Diff line number Diff line change
@@ -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
14 changes: 9 additions & 5 deletions doc/source/api/indices.rst → doc/source/api/indexing.rst
Original file line number Diff line number Diff line change
@@ -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/
3 changes: 2 additions & 1 deletion doc/source/api/io.rst
Original file line number Diff line number Diff line change
@@ -2,8 +2,9 @@

.. _api.io:

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

Pickling
96 changes: 49 additions & 47 deletions doc/source/api/offset_frequency.rst

Large diffs are not rendered by default.

5 changes: 3 additions & 2 deletions doc/source/api/panel.rst
Original file line number Diff line number Diff line change
@@ -2,8 +2,9 @@

.. _api.panel:

=====
Panel
------
=====
.. currentmodule:: pandas

Constructor
@@ -13,7 +14,7 @@ Constructor

Panel

Attributes and underlying data
Properties and underlying data
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
**Axes**

3 changes: 2 additions & 1 deletion doc/source/api/plotting.rst
Original file line number Diff line number Diff line change
@@ -2,8 +2,9 @@

.. _api.plotting:

========
Plotting
--------
========
.. currentmodule:: pandas.plotting

The following functions are contained in the `pandas.plotting` module.
3 changes: 2 additions & 1 deletion doc/source/api/resampling.rst
Original file line number Diff line number Diff line change
@@ -2,8 +2,9 @@

.. _api.resampling:

==========
Resampling
----------
==========
.. currentmodule:: pandas.core.resample

Resampler objects are returned by resample calls: :func:`pandas.DataFrame.resample`, :func:`pandas.Series.resample`.
13 changes: 7 additions & 6 deletions doc/source/api/scalars.rst
Original file line number Diff line number Diff line change
@@ -2,18 +2,19 @@

.. _api.scalars:

=======
Scalars
-------
=======
.. currentmodule:: pandas

Period
~~~~~~
------
.. autosummary::
:toctree: generated/

Period

Attributes
Properties
~~~~~~~~~~
.. autosummary::
:toctree: generated/
@@ -51,7 +52,7 @@ Methods
Period.to_timestamp

Timestamp
~~~~~~~~~
---------
.. autosummary::
:toctree: generated/

@@ -140,7 +141,7 @@ Methods
Timestamp.weekday

Interval
~~~~~~~~
--------
.. autosummary::
:toctree: generated/

@@ -163,7 +164,7 @@ Properties
Interval.right

Timedelta
~~~~~~~~~
---------
.. autosummary::
:toctree: generated/

57 changes: 29 additions & 28 deletions doc/source/api/series.rst
Original file line number Diff line number Diff line change
@@ -2,19 +2,20 @@

.. _api.series:

======
Series
------
======
.. currentmodule:: pandas

Constructor
~~~~~~~~~~~
-----------
.. autosummary::
:toctree: generated/

Series

Attributes
~~~~~~~~~~
----------
**Axes**

.. autosummary::
@@ -48,7 +49,7 @@ Attributes
Series.put

Conversion
~~~~~~~~~~
----------
.. autosummary::
:toctree: generated/

@@ -63,7 +64,7 @@ Conversion
Series.get_values

Indexing, iteration
~~~~~~~~~~~~~~~~~~~
-------------------
.. autosummary::
:toctree: generated/

@@ -84,7 +85,7 @@ For more information on ``.at``, ``.iat``, ``.loc``, and
``.iloc``, see the :ref:`indexing documentation <indexing>`.

Binary operator functions
~~~~~~~~~~~~~~~~~~~~~~~~~
-------------------------
.. autosummary::
:toctree: generated/

@@ -117,7 +118,7 @@ Binary operator functions
Series.dot

Function application, GroupBy & Window
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
--------------------------------------
.. autosummary::
:toctree: generated/

@@ -135,7 +136,7 @@ Function application, GroupBy & Window
.. _api.series.stats:

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

@@ -187,7 +188,7 @@ Computations / Descriptive Stats
Series.nonzero

Reindexing / Selection / Label manipulation
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-------------------------------------------
.. autosummary::
:toctree: generated/

@@ -221,7 +222,7 @@ Reindexing / Selection / Label manipulation
Series.filter

Missing data handling
~~~~~~~~~~~~~~~~~~~~~
---------------------
.. autosummary::
:toctree: generated/

@@ -232,7 +233,7 @@ Missing data handling
Series.interpolate

Reshaping, sorting
~~~~~~~~~~~~~~~~~~
------------------
.. autosummary::
:toctree: generated/

@@ -251,7 +252,7 @@ Reshaping, sorting
Series.view

Combining / joining / merging
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-----------------------------
.. autosummary::
:toctree: generated/

@@ -260,7 +261,7 @@ Combining / joining / merging
Series.update

Time series-related
~~~~~~~~~~~~~~~~~~~
-------------------
.. autosummary::
:toctree: generated/

@@ -278,13 +279,13 @@ Time series-related
Series.slice_shift

Datetimelike Properties
~~~~~~~~~~~~~~~~~~~~~~~
-----------------------
``Series.dt`` can be used to access the values of the series as
datetimelike and return several properties.
These can be accessed like ``Series.dt.<property>``.

**Datetime Properties**

Datetime Properties
~~~~~~~~~~~~~~~~~~~
.. autosummary::
:toctree: generated/
:template: autosummary/accessor_attribute.rst
@@ -318,8 +319,8 @@ These can be accessed like ``Series.dt.<property>``.
Series.dt.tz
Series.dt.freq

**Datetime Methods**

Datetime Methods
~~~~~~~~~~~~~~~~
.. autosummary::
:toctree: generated/
:template: autosummary/accessor_method.rst
@@ -336,8 +337,8 @@ These can be accessed like ``Series.dt.<property>``.
Series.dt.month_name
Series.dt.day_name

**Period Properties**

Period Properties
~~~~~~~~~~~~~~~~~
.. autosummary::
:toctree: generated/
:template: autosummary/accessor_attribute.rst
@@ -346,8 +347,8 @@ These can be accessed like ``Series.dt.<property>``.
Series.dt.start_time
Series.dt.end_time

**Timedelta Properties**

Timedelta Properties
~~~~~~~~~~~~~~~~~~~~
.. autosummary::
:toctree: generated/
:template: autosummary/accessor_attribute.rst
@@ -358,8 +359,8 @@ These can be accessed like ``Series.dt.<property>``.
Series.dt.nanoseconds
Series.dt.components

**Timedelta Methods**

Timedelta Methods
~~~~~~~~~~~~~~~~~
.. autosummary::
:toctree: generated/
:template: autosummary/accessor_method.rst
@@ -368,7 +369,7 @@ These can be accessed like ``Series.dt.<property>``.
Series.dt.total_seconds

String handling
~~~~~~~~~~~~~~~
---------------
``Series.str`` can be used to access the values of the series as
strings and apply several methods to it. These can be accessed like
``Series.str.<function/property>``.
@@ -543,7 +544,7 @@ following usable methods and properties:
Series.cat.as_unordered

Plotting
~~~~~~~~
--------
``Series.plot`` is both a callable method and a namespace attribute for
specific plotting methods of the form ``Series.plot.<kind>``.

@@ -573,7 +574,7 @@ specific plotting methods of the form ``Series.plot.<kind>``.
Series.hist

Serialization / IO / Conversion
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-------------------------------
.. autosummary::
:toctree: generated/

@@ -594,7 +595,7 @@ Serialization / IO / Conversion
Series.to_latex

Sparse
~~~~~~
------
.. autosummary::
:toctree: generated/

15 changes: 8 additions & 7 deletions doc/source/api/style.rst
Original file line number Diff line number Diff line change
@@ -2,22 +2,23 @@

.. _api.style:

=====
Style
-----
=====
.. currentmodule:: pandas.io.formats.style

``Styler`` objects are returned by :attr:`pandas.DataFrame.style`.

Styler Constructor
~~~~~~~~~~~~~~~~~~
------------------
.. autosummary::
:toctree: generated/

Styler
Styler.from_custom_template

Styler Attributes
~~~~~~~~~~~~~~~~~
Styler Properties
-----------------
.. autosummary::
:toctree: generated/

@@ -26,7 +27,7 @@ Styler Attributes
Styler.loader

Style Application
~~~~~~~~~~~~~~~~~
-----------------
.. autosummary::
:toctree: generated/

@@ -44,7 +45,7 @@ Style Application
Styler.pipe

Builtin Styles
~~~~~~~~~~~~~~
--------------
.. autosummary::
:toctree: generated/

@@ -55,7 +56,7 @@ Builtin Styles
Styler.bar

Style Export and Import
~~~~~~~~~~~~~~~~~~~~~~~
-----------------------
.. autosummary::
:toctree: generated/

9 changes: 5 additions & 4 deletions doc/source/api/window.rst
Original file line number Diff line number Diff line change
@@ -2,16 +2,17 @@

.. _api.window:

======
Window
------
======
.. currentmodule:: pandas.core.window

Rolling objects are returned by ``.rolling`` calls: :func:`pandas.DataFrame.rolling`, :func:`pandas.Series.rolling`, etc.
Expanding objects are returned by ``.expanding`` calls: :func:`pandas.DataFrame.expanding`, :func:`pandas.Series.expanding`, etc.
EWM objects are returned by ``.ewm`` calls: :func:`pandas.DataFrame.ewm`, :func:`pandas.Series.ewm`, etc.

Standard moving window functions
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
--------------------------------
.. autosummary::
:toctree: generated/

@@ -36,7 +37,7 @@ Standard moving window functions
.. _api.functions_expanding:

Standard expanding window functions
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-----------------------------------
.. autosummary::
:toctree: generated/

@@ -57,7 +58,7 @@ Standard expanding window functions
Expanding.quantile

Exponentially-weighted moving window functions
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
----------------------------------------------
.. autosummary::
:toctree: generated/