update docs

PurdueAF · Jan 29, 2024 · 97cf167 · 97cf167
1 parent 57f248b
commit 97cf167
Show file tree

Hide file tree

Showing 12 changed files with 149 additions and 5 deletions.
diff --git a/af_benchmark/__init__.py b/af_benchmark/__init__.py
diff --git a/af_benchmark/data_access/__init__.py b/af_benchmark/data_access/__init__.py
diff --git a/af_benchmark/executor/__init__.py b/af_benchmark/executor/__init__.py
diff --git a/af_benchmark/processing/__init__.py b/af_benchmark/processing/__init__.py
diff --git a/af_benchmark/profiling/__init__.py b/af_benchmark/profiling/__init__.py
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,8 +1,5 @@
-Analysis Facility Benchmark
-=================================
+.. include:: ../../README.md
 
 .. toctree::
-    :caption: API Reference
-    :maxdepth: 2
 
-    benchmark
+    modules/modules
diff --git a/docs/source/modules/af_benchmark.data_access.rst b/docs/source/modules/af_benchmark.data_access.rst
@@ -0,0 +1,21 @@
+af\_benchmark.data\_access package
+==================================
+
+Submodules
+----------
+
+af\_benchmark.data\_access.loader module
+----------------------------------------
+
+.. automodule:: af_benchmark.data_access.loader
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: af_benchmark.data_access
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/modules/af_benchmark.executor.rst b/docs/source/modules/af_benchmark.executor.rst
@@ -0,0 +1,45 @@
+af\_benchmark.executor package
+==============================
+
+Submodules
+----------
+
+af\_benchmark.executor.base module
+----------------------------------
+
+.. automodule:: af_benchmark.executor.base
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+af\_benchmark.executor.dask module
+----------------------------------
+
+.. automodule:: af_benchmark.executor.dask
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+af\_benchmark.executor.futures module
+-------------------------------------
+
+.. automodule:: af_benchmark.executor.futures
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+af\_benchmark.executor.sequential module
+----------------------------------------
+
+.. automodule:: af_benchmark.executor.sequential
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: af_benchmark.executor
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/modules/af_benchmark.processing.rst b/docs/source/modules/af_benchmark.processing.rst
@@ -0,0 +1,21 @@
+af\_benchmark.processing package
+================================
+
+Submodules
+----------
+
+af\_benchmark.processing.handler module
+---------------------------------------
+
+.. automodule:: af_benchmark.processing.handler
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: af_benchmark.processing
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/modules/af_benchmark.profiling.rst b/docs/source/modules/af_benchmark.profiling.rst
@@ -0,0 +1,21 @@
+af\_benchmark.profiling package
+===============================
+
+Submodules
+----------
+
+af\_benchmark.profiling.timing module
+-------------------------------------
+
+.. automodule:: af_benchmark.profiling.timing
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: af_benchmark.profiling
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/modules/af_benchmark.rst b/docs/source/modules/af_benchmark.rst
@@ -0,0 +1,32 @@
+af\_benchmark package
+=====================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   af_benchmark.data_access
+   af_benchmark.executor
+   af_benchmark.processing
+   af_benchmark.profiling
+
+Submodules
+----------
+
+af\_benchmark.benchmark module
+------------------------------
+
+.. automodule:: af_benchmark.benchmark
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: af_benchmark
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/modules/modules.rst b/docs/source/modules/modules.rst
@@ -0,0 +1,7 @@
+af_benchmark
+============
+
+.. toctree::
+   :maxdepth: 4
+
+   af_benchmark