docs: regenerate apidoc files (#503)

hatchet · Apr 23, 2023 · 9ac36f1 · 9ac36f1
1 parent 19a1406
commit 9ac36f1
Show file tree

Hide file tree

Showing 7 changed files with 169 additions and 9 deletions.
diff --git a/docs/source/hatchet.cython_modules.libs.rst b/docs/source/hatchet.cython_modules.libs.rst
@@ -4,14 +4,21 @@ hatchet.cython\_modules.libs package
 Submodules
 ----------
 
-hatchet.cython\_modules.libs.subtract\_metrics module
------------------------------------------------------
+hatchet.cython\_modules.libs.graphframe\_modules module
+-------------------------------------------------------
 
-.. automodule:: hatchet.cython_modules.libs.subtract_metrics
+.. automodule:: hatchet.cython_modules.libs.graphframe_modules
    :members:
    :undoc-members:
    :show-inheritance:
 
+hatchet.cython\_modules.libs.reader\_modules module
+---------------------------------------------------
+
+.. automodule:: hatchet.cython_modules.libs.reader_modules
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
 Module contents
 ---------------

diff --git a/docs/source/hatchet.cython_modules.rst b/docs/source/hatchet.cython_modules.rst
@@ -12,14 +12,21 @@ Subpackages
 Submodules
 ----------
 
-hatchet.cython\_modules.subtract\_metrics module
-------------------------------------------------
+hatchet.cython\_modules.graphframe\_modules module
+--------------------------------------------------
 
-.. automodule:: hatchet.cython_modules.subtract_metrics
+.. automodule:: hatchet.cython_modules.graphframe_modules
    :members:
    :undoc-members:
    :show-inheritance:
 
+hatchet.cython\_modules.reader\_modules module
+----------------------------------------------
+
+.. automodule:: hatchet.cython_modules.reader_modules
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
 Module contents
 ---------------

diff --git a/docs/source/hatchet.external.rst b/docs/source/hatchet.external.rst
@@ -12,7 +12,6 @@ hatchet.external.console module
    :undoc-members:
    :show-inheritance:
 
-
 Module contents
 ---------------
 

diff --git a/docs/source/hatchet.readers.rst b/docs/source/hatchet.readers.rst
@@ -4,6 +4,22 @@ hatchet.readers package
 Submodules
 ----------
 
+hatchet.readers.apex\_reader module
+-----------------------------------
+
+.. automodule:: hatchet.readers.apex_reader
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+hatchet.readers.caliper\_native\_reader module
+----------------------------------------------
+
+.. automodule:: hatchet.readers.caliper_native_reader
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 hatchet.readers.caliper\_reader module
 --------------------------------------
 
@@ -12,6 +28,22 @@ hatchet.readers.caliper\_reader module
    :undoc-members:
    :show-inheritance:
 
+hatchet.readers.cprofile\_reader module
+---------------------------------------
+
+.. automodule:: hatchet.readers.cprofile_reader
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+hatchet.readers.dataframe\_reader module
+----------------------------------------
+
+.. automodule:: hatchet.readers.dataframe_reader
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 hatchet.readers.gprof\_dot\_reader module
 -----------------------------------------
 
@@ -20,6 +52,14 @@ hatchet.readers.gprof\_dot\_reader module
    :undoc-members:
    :show-inheritance:
 
+hatchet.readers.hdf5\_reader module
+-----------------------------------
+
+.. automodule:: hatchet.readers.hdf5_reader
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 hatchet.readers.hpctoolkit\_reader module
 -----------------------------------------
 
@@ -28,6 +68,53 @@ hatchet.readers.hpctoolkit\_reader module
    :undoc-members:
    :show-inheritance:
 
+hatchet.readers.literal\_reader module
+--------------------------------------
+
+.. automodule:: hatchet.readers.literal_reader
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+hatchet.readers.pyinstrument\_reader module
+-------------------------------------------
+
+.. automodule:: hatchet.readers.pyinstrument_reader
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+hatchet.readers.scorep\_reader module
+-------------------------------------
+
+.. automodule:: hatchet.readers.scorep_reader
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+hatchet.readers.spotdb\_reader module
+-------------------------------------
+
+.. automodule:: hatchet.readers.spotdb_reader
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+hatchet.readers.tau\_reader module
+----------------------------------
+
+.. automodule:: hatchet.readers.tau_reader
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+hatchet.readers.timemory\_reader module
+---------------------------------------
+
+.. automodule:: hatchet.readers.timemory_reader
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
 Module contents
 ---------------

diff --git a/docs/source/hatchet.rst b/docs/source/hatchet.rst
@@ -11,10 +11,19 @@ Subpackages
    hatchet.external
    hatchet.readers
    hatchet.util
+   hatchet.writers
 
 Submodules
 ----------
 
+hatchet.chopper module
+----------------------
+
+.. automodule:: hatchet.chopper
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 hatchet.frame module
 --------------------
 
@@ -48,13 +57,20 @@ hatchet.node module
    :show-inheritance:
 
 hatchet.query module
------------------------------
+--------------------
 
 .. automodule:: hatchet.query
    :members:
    :undoc-members:
    :show-inheritance:
 
+hatchet.version module
+----------------------
+
+.. automodule:: hatchet.version
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
 Module contents
 ---------------

diff --git a/docs/source/hatchet.util.rst b/docs/source/hatchet.util.rst
@@ -4,6 +4,14 @@ hatchet.util package
 Submodules
 ----------
 
+hatchet.util.colormaps module
+-----------------------------
+
+.. automodule:: hatchet.util.colormaps
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 hatchet.util.config module
 --------------------------
 
@@ -36,6 +44,14 @@ hatchet.util.executable module
    :undoc-members:
    :show-inheritance:
 
+hatchet.util.logger module
+--------------------------
+
+.. automodule:: hatchet.util.logger
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 hatchet.util.profiler module
 ----------------------------
 
@@ -52,7 +68,6 @@ hatchet.util.timer module
    :undoc-members:
    :show-inheritance:
 
-
 Module contents
 ---------------
 

diff --git a/docs/source/hatchet.writers.rst b/docs/source/hatchet.writers.rst
@@ -0,0 +1,29 @@
+hatchet.writers package
+=======================
+
+Submodules
+----------
+
+hatchet.writers.dataframe\_writer module
+----------------------------------------
+
+.. automodule:: hatchet.writers.dataframe_writer
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+hatchet.writers.hdf5\_writer module
+-----------------------------------
+
+.. automodule:: hatchet.writers.hdf5_writer
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: hatchet.writers
+   :members:
+   :undoc-members:
+   :show-inheritance: