.. _api:

=============
API reference
=============

.. This page gives an overview of all public pyufunc objects, functions and
.. methods. All classes and functions exposed in ``pyufunc.*`` namespace are public.
..
.. The following subpackages are public.
..
.. - ``pyufunc.util_ai``: AI related utility functions.
.. - ``pyufunc.util_algorithm``: Algorithm utility functions.
.. - ``pyufunc.util_magic``: Magic unclassified utility functions.
.. - ``pyufunc.util_data_processing``: Data processing utility functions.
.. - ``pyufunc.util_datetime``: Date and time utility functions.
.. - ``pyufunc.util_geo``: Geospatial utility functions.
.. - ``pyufunc.util_git_pypi``: GitHub and PyPI utility functions.
.. - ``pyufunc.util_img``: Image utility functions.
.. - ``pyufunc.util_log``: Logging utility functions.
.. - ``pyufunc.util_network``: Network utility functions.
.. - ``pyufunc.util_office``: Office (word, excel, ppt) related utility functions.
.. - ``pyufunc.util_pathio``: Path related utility functions.
.. - ``pyufunc.util_test``: Test utility functions.
.. - ``pyufunc.cfg``: Package configurations.


.. If you update this toctree, also update the manual toctree in the
.. main index.rst.template

.. toctree::
   :maxdepth: 3

   util_magic
   util_data_processing
   util_datetime
   util_pathio
   util_test
   util_geo
   util_git_pypi
   util_img
   util_log
   util_network
   util_office
   util_ai
   util_algorithm
   util_pkgs
   third_party_licenses
   cfg