Skip to content

Commit 354f10a

Browse files
committed
Add DatetimeIndex and Index documentation.
Start documentation for DatetimeIndex and Index.
1 parent 406e43b commit 354f10a

File tree

1 file changed

+146
-0
lines changed

1 file changed

+146
-0
lines changed

doc/source/api.rst

+146
Original file line numberDiff line numberDiff line change
@@ -868,3 +868,149 @@ Serialization / IO / Conversion
868868
Panel.to_frame
869869
Panel.to_clipboard
870870

871+
.. currentmodule:: pandas.core.index
872+
873+
.. _api.index
874+
875+
Index
876+
-----
877+
878+
**Many of these methods or variants thereof are available on the objects that contain an index (Series/Dataframe)
879+
and those should most likely be used before calling these methods directly.**
880+
881+
* **values**
882+
Modifying and Computations
883+
~~~~~~~~~~~~~~~~~~~~~~~~~~
884+
.. autosummary::
885+
:toctree: generated/
886+
887+
Index.copy
888+
Index.delete
889+
Index.diff
890+
Index.drop
891+
Index.equals
892+
Index.identical
893+
Index.insert
894+
Index.order
895+
Index.reindex
896+
Index.repeat
897+
Index.set_names
898+
Index.unique
899+
900+
Conversion
901+
~~~~~~~~~~
902+
.. autosummary::
903+
:toctree: generated/
904+
905+
Index.astype
906+
Index.tolist
907+
Index.to_datetime
908+
Index.to_series
909+
910+
Sorting
911+
~~~~~~~
912+
.. autosummary::
913+
:toctree: generated/
914+
915+
Index.argsort
916+
Index.order
917+
Index.sort
918+
919+
Time-specific operations
920+
~~~~~~~~~~~~~~~~~~~~~~~~
921+
.. autosummary::
922+
:toctree: generated/
923+
924+
Index.shift
925+
926+
Combining / joining / merging
927+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
928+
.. autosummary::
929+
:toctree: generated/
930+
931+
Index.append
932+
Index.intersection
933+
Index.join
934+
Index.union
935+
936+
Selecting
937+
~~~~~~~~~
938+
.. autosummary::
939+
:toctree: generated/
940+
941+
Index.get_indexer
942+
Index.get_indexer_non_unique
943+
Index.get_level_values
944+
Index.get_loc
945+
Index.get_value
946+
Index.isin
947+
Index.slice_indexer
948+
Index.slice_locs
949+
950+
Properties
951+
~~~~~~~~~~
952+
.. autosummary::
953+
:toctree: generated/
954+
955+
Index.is_monotonic
956+
Index.is_numeric
957+
958+
.. currentmodule:: pandas.tseries.index
959+
960+
.. _api.datetimeindex:
961+
962+
DatetimeIndex
963+
-------------
964+
965+
Time/Date Components
966+
~~~~~~~~~~~~~~~~~~~~
967+
* **year**
968+
* **month**
969+
* **day**
970+
* **hour**
971+
* **minute**
972+
* **second**
973+
* **microsecond**
974+
* **nanosecond**
975+
976+
* **weekofyear**
977+
* **week**: Same as weekofyear
978+
* **dayofweek**: (0=Monday, 6=Sunday)
979+
* **weekday**: (0=Monday, 6=Sunday)
980+
* **dayofyear**
981+
* **quarter**
982+
983+
* **date**: Returns date component of Timestamps
984+
* **time**: Returns time component of Timestamps
985+
986+
987+
Selecting
988+
~~~~~~~~~
989+
.. autosummary::
990+
:toctree: generated/
991+
992+
DatetimeIndex.indexer_at_time
993+
DatetimeIndex.indexer_between_time
994+
995+
996+
Time-specific operations
997+
~~~~~~~~~~~~~~~~~~~~~~~~
998+
.. autosummary::
999+
:toctree: generated/
1000+
1001+
DatetimeIndex.normalize
1002+
DatetimeIndex.snap
1003+
DatetimeIndex.tz_convert
1004+
DatetimeIndex.tz_localize
1005+
1006+
1007+
Conversion
1008+
~~~~~~~~~~
1009+
.. autosummary::
1010+
:toctree: generated/
1011+
1012+
DatetimeIndex.to_datetime
1013+
DatetimeIndex.to_period
1014+
DatetimeIndex.to_pydatetime
1015+
1016+

0 commit comments

Comments
 (0)