diff --git a/docs/api.rst b/docs/api.rst index 65c90f0..4d50585 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -1,8 +1,14 @@ API === -.. automodule:: gpu_tracker - +gpu_tracker.tracker +------------------- .. automodule:: gpu_tracker.tracker :members: :undoc-members: + +gpu_tracker.sub_tracker +----------------------- +.. automodule:: gpu_tracker.sub_tracker + :members: + :undoc-members: diff --git a/src/gpu_tracker/sub_tracker.py b/src/gpu_tracker/sub_tracker.py index 5d9f633..b0bb975 100644 --- a/src/gpu_tracker/sub_tracker.py +++ b/src/gpu_tracker/sub_tracker.py @@ -1,4 +1,4 @@ -"""The ``sub_tracker`` module contains the ``SubTracker`` class which can alternatively be imported directly from the ``gpu_tracker`` package.""" +"""The ``sub_tracker`` module contains the ``SubTracker`` class which can alternatively be imported directly from the ``gpu_tracker`` package. Additionally, it contains the ``SubTrackingAnalyzer`` class which generates the ``SubTrackingResults`` from the data produced by the ``SubTracker`` and finally the ``TrackingComparison`` which generates the ``ComparisonResults`` comparing the ``SubTrackingResults`` of multiple tracking sessions.""" from __future__ import annotations import inspect import os