Skip to content

DOC: reduce API docs for offset aliases #34433

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 4 commits into from
Jun 19, 2020
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
299 changes: 54 additions & 245 deletions doc/source/reference/offset_frequency.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,11 +42,20 @@ Methods

BusinessDay
-----------

.. autosummary::
:toctree: api/

BusinessDay

Alias:

.. autosummary::
:toctree: api/
:template: autosummary/class_without_autosummary.rst

BDay

Properties
~~~~~~~~~~
.. autosummary::
Expand Down Expand Up @@ -117,11 +126,20 @@ Methods

CustomBusinessDay
-----------------

.. autosummary::
:toctree: api/

CustomBusinessDay

Alias:

.. autosummary::
:toctree: api/
:template: autosummary/class_without_autosummary.rst

CDay

Properties
~~~~~~~~~~
.. autosummary::
Expand Down Expand Up @@ -260,11 +278,20 @@ Methods

BusinessMonthEnd
----------------

.. autosummary::
:toctree: api/

BusinessMonthEnd

Alias:

.. autosummary::
:toctree: api/
:template: autosummary/class_without_autosummary.rst

BMonthEnd

Properties
~~~~~~~~~~
.. autosummary::
Expand Down Expand Up @@ -294,11 +321,20 @@ Methods

BusinessMonthBegin
------------------

.. autosummary::
:toctree: api/

BusinessMonthBegin

Alias:

.. autosummary::
:toctree: api/
:template: autosummary/class_without_autosummary.rst

BMonthBegin

Properties
~~~~~~~~~~
.. autosummary::
Expand Down Expand Up @@ -328,11 +364,20 @@ Methods

CustomBusinessMonthEnd
----------------------

.. autosummary::
:toctree: api/

CustomBusinessMonthEnd

Alias:

.. autosummary::
:toctree: api/
:template: autosummary/class_without_autosummary.rst

CBMonthEnd

Properties
~~~~~~~~~~
.. autosummary::
Expand Down Expand Up @@ -365,11 +410,20 @@ Methods

CustomBusinessMonthBegin
------------------------

.. autosummary::
:toctree: api/

CustomBusinessMonthBegin

Alias:

.. autosummary::
:toctree: api/
:template: autosummary/class_without_autosummary.rst

CBMonthBegin

Properties
~~~~~~~~~~
.. autosummary::
Expand Down Expand Up @@ -1238,251 +1292,6 @@ Methods
Nano.__call__
Nano.apply

BDay
----
.. autosummary::
:toctree: api/

BDay

Properties
~~~~~~~~~~
.. autosummary::
:toctree: api/

BDay.base
BDay.freqstr
BDay.kwds
BDay.name
BDay.nanos
BDay.normalize
BDay.offset
BDay.rule_code
BDay.n
BDay.weekmask
BDay.holidays
BDay.calendar

Methods
~~~~~~~
.. autosummary::
:toctree: api/

BDay.apply
BDay.apply_index
BDay.copy
BDay.isAnchored
BDay.onOffset
BDay.is_anchored
BDay.is_on_offset
BDay.rollback
BDay.rollforward
BDay.__call__

BMonthEnd
---------
.. autosummary::
:toctree: api/

BMonthEnd

Properties
~~~~~~~~~~
.. autosummary::
:toctree: api/

BMonthEnd.base
BMonthEnd.freqstr
BMonthEnd.kwds
BMonthEnd.name
BMonthEnd.nanos
BMonthEnd.normalize
BMonthEnd.rule_code
BMonthEnd.n

Methods
~~~~~~~
.. autosummary::
:toctree: api/

BMonthEnd.apply
BMonthEnd.apply_index
BMonthEnd.copy
BMonthEnd.isAnchored
BMonthEnd.onOffset
BMonthEnd.is_anchored
BMonthEnd.is_on_offset
BMonthEnd.rollback
BMonthEnd.rollforward
BMonthEnd.__call__

BMonthBegin
-----------
.. autosummary::
:toctree: api/

BMonthBegin

Properties
~~~~~~~~~~
.. autosummary::
:toctree: api/

BMonthBegin.base
BMonthBegin.freqstr
BMonthBegin.kwds
BMonthBegin.name
BMonthBegin.nanos
BMonthBegin.normalize
BMonthBegin.rule_code
BMonthBegin.n

Methods
~~~~~~~
.. autosummary::
:toctree: api/

BMonthBegin.apply
BMonthBegin.apply_index
BMonthBegin.copy
BMonthBegin.isAnchored
BMonthBegin.onOffset
BMonthBegin.is_anchored
BMonthBegin.is_on_offset
BMonthBegin.rollback
BMonthBegin.rollforward
BMonthBegin.__call__

CBMonthEnd
----------
.. autosummary::
:toctree: api/

CBMonthEnd

Properties
~~~~~~~~~~
.. autosummary::
:toctree: api/

CBMonthEnd.base
CBMonthEnd.cbday_roll
CBMonthEnd.freqstr
CBMonthEnd.kwds
CBMonthEnd.m_offset
CBMonthEnd.month_roll
CBMonthEnd.name
CBMonthEnd.nanos
CBMonthEnd.normalize
CBMonthEnd.offset
CBMonthEnd.rule_code
CBMonthEnd.n
CBMonthEnd.weekmask
CBMonthEnd.holidays
CBMonthEnd.calendar

Methods
~~~~~~~
.. autosummary::
:toctree: api/

CBMonthEnd.apply
CBMonthEnd.apply_index
CBMonthEnd.copy
CBMonthEnd.isAnchored
CBMonthEnd.onOffset
CBMonthEnd.is_anchored
CBMonthEnd.is_on_offset
CBMonthEnd.rollback
CBMonthEnd.rollforward
CBMonthEnd.__call__

CBMonthBegin
------------
.. autosummary::
:toctree: api/

CBMonthBegin

Properties
~~~~~~~~~~
.. autosummary::
:toctree: api/

CBMonthBegin.base
CBMonthBegin.cbday_roll
CBMonthBegin.freqstr
CBMonthBegin.kwds
CBMonthBegin.m_offset
CBMonthBegin.month_roll
CBMonthBegin.name
CBMonthBegin.nanos
CBMonthBegin.normalize
CBMonthBegin.offset
CBMonthBegin.rule_code
CBMonthBegin.n
CBMonthBegin.weekmask
CBMonthBegin.holidays
CBMonthBegin.calendar

Methods
~~~~~~~
.. autosummary::
:toctree: api/

CBMonthBegin.apply
CBMonthBegin.apply_index
CBMonthBegin.copy
CBMonthBegin.isAnchored
CBMonthBegin.onOffset
CBMonthBegin.is_anchored
CBMonthBegin.is_on_offset
CBMonthBegin.rollback
CBMonthBegin.rollforward
CBMonthBegin.__call__

CDay
----
.. autosummary::
:toctree: api/

CDay

Properties
~~~~~~~~~~
.. autosummary::
:toctree: api/

CDay.base
CDay.freqstr
CDay.kwds
CDay.name
CDay.nanos
CDay.normalize
CDay.offset
CDay.rule_code
CDay.n
CDay.weekmask
CDay.calendar
CDay.holidays

Methods
~~~~~~~
.. autosummary::
:toctree: api/

CDay.apply
CDay.apply_index
CDay.copy
CDay.isAnchored
CDay.onOffset
CDay.is_anchored
CDay.is_on_offset
CDay.rollback
CDay.rollforward
CDay.__call__


.. _api.frequencies:

===========
Expand Down