WIP: documented py_utils.utils_segmentation

Author: ChadLin9596

docs/source/api.rst

@@ -0,0 +1,10 @@
+API Reference
+=============
+
+Each submodule provides independent functionality and has its own
+optional dependencies.
+
+.. toctree::
+   :maxdepth: 1
+
+   utils_segmentation

docs/source/api/index.rst

@@ -0,0 +1,30 @@
+py_utils.utils_segmentation
+===========================
+
+.. automodule:: py_utils.utils_segmentation
+   :no-members:
+
+
+-------------------------------------------
+Sliding Window Utilities
+-------------------------------------------
+
+.. autofunction:: py_utils.utils_segmentation.compute_sliding_window_indices
+.. autofunction:: py_utils.utils_segmentation.sliding_window
+
+
+-------------------------------------------
+Segmented Reduction Utilities
+-------------------------------------------
+
+.. autofunction:: py_utils.utils_segmentation.segmented_argmin
+.. autofunction:: py_utils.utils_segmentation.segmented_argmax
+.. autofunction:: py_utils.utils_segmentation.segmented_min
+.. autofunction:: py_utils.utils_segmentation.segmented_max
+
+.. autofunction:: py_utils.utils_segmentation.segmented_count
+.. autofunction:: py_utils.utils_segmentation.segmented_sum
+.. autofunction:: py_utils.utils_segmentation.segmented_mean
+
+.. autofunction:: py_utils.utils_segmentation.segmented_where
+

docs/source/api/utils_segmentation.rst

@@ -45,8 +45,5 @@
 
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
-
-# html_theme = "alabaster"
-# html_theme = "python_docs_theme"
 html_theme = "haiku"
 html_static_path = ["_static"]

docs/source/conf.py

@@ -0,0 +1,15 @@
+Dependencies
+============
+
+Below are module-level dependencies and links to full API details.
+
+
+Segmentation Utils
+------------------
+
+:mod:`py_utils.utils_segmentation`
+
+.. automodule:: py_utils.utils_segmentation
+   :no-members:
+   :no-undoc-members:
+   :no-index:

docs/source/dependency.rst

@@ -1,24 +1,29 @@
-.. py_utils documentation master file, created by
-   sphinx-quickstart on Tue Nov 11 10:15:30 2025.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
+.. note::
+   This project is under active development. Documentation may change frequently.
 
-py_utils Documentation
-======================
+`GitHub Repository`_.
 
-Add your content using ``reStructuredText`` syntax. See the
-`reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_
-documentation for details.
 
-Check out the :doc:`usage` section for further information, including how to
-:ref:`install <installation>` the project.
+Getting Started
+===============
 
-.. note::
-   This project is under active development. Documentation may change frequently.
+.. Check out the :doc:`usage` section for further information, including how to
+.. :ref:`install <installation>` the project.
 
 .. toctree::
-   :maxdepth: 2
-   :caption: Contents:
+   :maxdepth: 1
+
+   installation
+   dependency
+   api/index
+
+Indices and Tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
 
-   usage
-   api
+.. comment: list link used in the file above
+.. _GitHub Repository: https://github.com/ChadLin9596/python_utils

docs/source/generated/py_utils.utils_segmentation.rst

@@ -0,0 +1,44 @@
+Installation
+============
+
+Install from GitHub
+-------------------
+
+.. code-block:: bash
+
+    $ pip install git+https://github.com/ChadLin9596/python_utils.git
+
+Custom Installation
+-------------------
+
+``python_utils`` is modular. Each submodule has its own optional
+dependencies. You only need to install the dependencies for the parts you
+use.
+
+Check the full module-level dependency list here:
+
+:doc:`Dependency Overview <dependency>`
+
+
+Examples
+--------
+
+** Install only segmentation utilities:**
+
+.. code-block:: bash
+
+    pip install numpy_reduceat_ext numpy
+
+then use
+
+.. code-block:: python
+
+    import py_utils.utils_segmentation
+
+
+Notes
+-----
+
+- Importing a submodule does **not** pull dependencies from other modules.
+- If you don’t import a heavy module (e.g., ``utils_torch``), its dependencies are never loaded.
+- Each module’s required dependencies are documented at the top of its API page and in the :doc:`dependency` page.