Skip to content

Commit c823642

Browse files
DOC: reduce API docs for offset aliases (pandas-dev#34433)
1 parent f64df3a commit c823642

File tree

1 file changed

+54
-245
lines changed

1 file changed

+54
-245
lines changed

doc/source/reference/offset_frequency.rst

+54-245
Original file line numberDiff line numberDiff line change
@@ -42,11 +42,20 @@ Methods
4242

4343
BusinessDay
4444
-----------
45+
4546
.. autosummary::
4647
:toctree: api/
4748

4849
BusinessDay
4950

51+
Alias:
52+
53+
.. autosummary::
54+
:toctree: api/
55+
:template: autosummary/class_without_autosummary.rst
56+
57+
BDay
58+
5059
Properties
5160
~~~~~~~~~~
5261
.. autosummary::
@@ -117,11 +126,20 @@ Methods
117126

118127
CustomBusinessDay
119128
-----------------
129+
120130
.. autosummary::
121131
:toctree: api/
122132

123133
CustomBusinessDay
124134

135+
Alias:
136+
137+
.. autosummary::
138+
:toctree: api/
139+
:template: autosummary/class_without_autosummary.rst
140+
141+
CDay
142+
125143
Properties
126144
~~~~~~~~~~
127145
.. autosummary::
@@ -260,11 +278,20 @@ Methods
260278

261279
BusinessMonthEnd
262280
----------------
281+
263282
.. autosummary::
264283
:toctree: api/
265284

266285
BusinessMonthEnd
267286

287+
Alias:
288+
289+
.. autosummary::
290+
:toctree: api/
291+
:template: autosummary/class_without_autosummary.rst
292+
293+
BMonthEnd
294+
268295
Properties
269296
~~~~~~~~~~
270297
.. autosummary::
@@ -294,11 +321,20 @@ Methods
294321

295322
BusinessMonthBegin
296323
------------------
324+
297325
.. autosummary::
298326
:toctree: api/
299327

300328
BusinessMonthBegin
301329

330+
Alias:
331+
332+
.. autosummary::
333+
:toctree: api/
334+
:template: autosummary/class_without_autosummary.rst
335+
336+
BMonthBegin
337+
302338
Properties
303339
~~~~~~~~~~
304340
.. autosummary::
@@ -328,11 +364,20 @@ Methods
328364

329365
CustomBusinessMonthEnd
330366
----------------------
367+
331368
.. autosummary::
332369
:toctree: api/
333370

334371
CustomBusinessMonthEnd
335372

373+
Alias:
374+
375+
.. autosummary::
376+
:toctree: api/
377+
:template: autosummary/class_without_autosummary.rst
378+
379+
CBMonthEnd
380+
336381
Properties
337382
~~~~~~~~~~
338383
.. autosummary::
@@ -365,11 +410,20 @@ Methods
365410

366411
CustomBusinessMonthBegin
367412
------------------------
413+
368414
.. autosummary::
369415
:toctree: api/
370416

371417
CustomBusinessMonthBegin
372418

419+
Alias:
420+
421+
.. autosummary::
422+
:toctree: api/
423+
:template: autosummary/class_without_autosummary.rst
424+
425+
CBMonthBegin
426+
373427
Properties
374428
~~~~~~~~~~
375429
.. autosummary::
@@ -1238,251 +1292,6 @@ Methods
12381292
Nano.__call__
12391293
Nano.apply
12401294

1241-
BDay
1242-
----
1243-
.. autosummary::
1244-
:toctree: api/
1245-
1246-
BDay
1247-
1248-
Properties
1249-
~~~~~~~~~~
1250-
.. autosummary::
1251-
:toctree: api/
1252-
1253-
BDay.base
1254-
BDay.freqstr
1255-
BDay.kwds
1256-
BDay.name
1257-
BDay.nanos
1258-
BDay.normalize
1259-
BDay.offset
1260-
BDay.rule_code
1261-
BDay.n
1262-
BDay.weekmask
1263-
BDay.holidays
1264-
BDay.calendar
1265-
1266-
Methods
1267-
~~~~~~~
1268-
.. autosummary::
1269-
:toctree: api/
1270-
1271-
BDay.apply
1272-
BDay.apply_index
1273-
BDay.copy
1274-
BDay.isAnchored
1275-
BDay.onOffset
1276-
BDay.is_anchored
1277-
BDay.is_on_offset
1278-
BDay.rollback
1279-
BDay.rollforward
1280-
BDay.__call__
1281-
1282-
BMonthEnd
1283-
---------
1284-
.. autosummary::
1285-
:toctree: api/
1286-
1287-
BMonthEnd
1288-
1289-
Properties
1290-
~~~~~~~~~~
1291-
.. autosummary::
1292-
:toctree: api/
1293-
1294-
BMonthEnd.base
1295-
BMonthEnd.freqstr
1296-
BMonthEnd.kwds
1297-
BMonthEnd.name
1298-
BMonthEnd.nanos
1299-
BMonthEnd.normalize
1300-
BMonthEnd.rule_code
1301-
BMonthEnd.n
1302-
1303-
Methods
1304-
~~~~~~~
1305-
.. autosummary::
1306-
:toctree: api/
1307-
1308-
BMonthEnd.apply
1309-
BMonthEnd.apply_index
1310-
BMonthEnd.copy
1311-
BMonthEnd.isAnchored
1312-
BMonthEnd.onOffset
1313-
BMonthEnd.is_anchored
1314-
BMonthEnd.is_on_offset
1315-
BMonthEnd.rollback
1316-
BMonthEnd.rollforward
1317-
BMonthEnd.__call__
1318-
1319-
BMonthBegin
1320-
-----------
1321-
.. autosummary::
1322-
:toctree: api/
1323-
1324-
BMonthBegin
1325-
1326-
Properties
1327-
~~~~~~~~~~
1328-
.. autosummary::
1329-
:toctree: api/
1330-
1331-
BMonthBegin.base
1332-
BMonthBegin.freqstr
1333-
BMonthBegin.kwds
1334-
BMonthBegin.name
1335-
BMonthBegin.nanos
1336-
BMonthBegin.normalize
1337-
BMonthBegin.rule_code
1338-
BMonthBegin.n
1339-
1340-
Methods
1341-
~~~~~~~
1342-
.. autosummary::
1343-
:toctree: api/
1344-
1345-
BMonthBegin.apply
1346-
BMonthBegin.apply_index
1347-
BMonthBegin.copy
1348-
BMonthBegin.isAnchored
1349-
BMonthBegin.onOffset
1350-
BMonthBegin.is_anchored
1351-
BMonthBegin.is_on_offset
1352-
BMonthBegin.rollback
1353-
BMonthBegin.rollforward
1354-
BMonthBegin.__call__
1355-
1356-
CBMonthEnd
1357-
----------
1358-
.. autosummary::
1359-
:toctree: api/
1360-
1361-
CBMonthEnd
1362-
1363-
Properties
1364-
~~~~~~~~~~
1365-
.. autosummary::
1366-
:toctree: api/
1367-
1368-
CBMonthEnd.base
1369-
CBMonthEnd.cbday_roll
1370-
CBMonthEnd.freqstr
1371-
CBMonthEnd.kwds
1372-
CBMonthEnd.m_offset
1373-
CBMonthEnd.month_roll
1374-
CBMonthEnd.name
1375-
CBMonthEnd.nanos
1376-
CBMonthEnd.normalize
1377-
CBMonthEnd.offset
1378-
CBMonthEnd.rule_code
1379-
CBMonthEnd.n
1380-
CBMonthEnd.weekmask
1381-
CBMonthEnd.holidays
1382-
CBMonthEnd.calendar
1383-
1384-
Methods
1385-
~~~~~~~
1386-
.. autosummary::
1387-
:toctree: api/
1388-
1389-
CBMonthEnd.apply
1390-
CBMonthEnd.apply_index
1391-
CBMonthEnd.copy
1392-
CBMonthEnd.isAnchored
1393-
CBMonthEnd.onOffset
1394-
CBMonthEnd.is_anchored
1395-
CBMonthEnd.is_on_offset
1396-
CBMonthEnd.rollback
1397-
CBMonthEnd.rollforward
1398-
CBMonthEnd.__call__
1399-
1400-
CBMonthBegin
1401-
------------
1402-
.. autosummary::
1403-
:toctree: api/
1404-
1405-
CBMonthBegin
1406-
1407-
Properties
1408-
~~~~~~~~~~
1409-
.. autosummary::
1410-
:toctree: api/
1411-
1412-
CBMonthBegin.base
1413-
CBMonthBegin.cbday_roll
1414-
CBMonthBegin.freqstr
1415-
CBMonthBegin.kwds
1416-
CBMonthBegin.m_offset
1417-
CBMonthBegin.month_roll
1418-
CBMonthBegin.name
1419-
CBMonthBegin.nanos
1420-
CBMonthBegin.normalize
1421-
CBMonthBegin.offset
1422-
CBMonthBegin.rule_code
1423-
CBMonthBegin.n
1424-
CBMonthBegin.weekmask
1425-
CBMonthBegin.holidays
1426-
CBMonthBegin.calendar
1427-
1428-
Methods
1429-
~~~~~~~
1430-
.. autosummary::
1431-
:toctree: api/
1432-
1433-
CBMonthBegin.apply
1434-
CBMonthBegin.apply_index
1435-
CBMonthBegin.copy
1436-
CBMonthBegin.isAnchored
1437-
CBMonthBegin.onOffset
1438-
CBMonthBegin.is_anchored
1439-
CBMonthBegin.is_on_offset
1440-
CBMonthBegin.rollback
1441-
CBMonthBegin.rollforward
1442-
CBMonthBegin.__call__
1443-
1444-
CDay
1445-
----
1446-
.. autosummary::
1447-
:toctree: api/
1448-
1449-
CDay
1450-
1451-
Properties
1452-
~~~~~~~~~~
1453-
.. autosummary::
1454-
:toctree: api/
1455-
1456-
CDay.base
1457-
CDay.freqstr
1458-
CDay.kwds
1459-
CDay.name
1460-
CDay.nanos
1461-
CDay.normalize
1462-
CDay.offset
1463-
CDay.rule_code
1464-
CDay.n
1465-
CDay.weekmask
1466-
CDay.calendar
1467-
CDay.holidays
1468-
1469-
Methods
1470-
~~~~~~~
1471-
.. autosummary::
1472-
:toctree: api/
1473-
1474-
CDay.apply
1475-
CDay.apply_index
1476-
CDay.copy
1477-
CDay.isAnchored
1478-
CDay.onOffset
1479-
CDay.is_anchored
1480-
CDay.is_on_offset
1481-
CDay.rollback
1482-
CDay.rollforward
1483-
CDay.__call__
1484-
1485-
14861295
.. _api.frequencies:
14871296

14881297
===========

0 commit comments

Comments
 (0)