Add index for user guide in side bar

rjavadi · rjavadi · commit 5fdcacb2a0de · 2024-01-26T16:34:22.000-08:00
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -9,12 +9,7 @@ Welcome to cyclops's documentation!
    intro
    contributing
    tutorials
+   user_guide
    api
 
-.. toctree::
-   :maxdepth: 2
-   :name: guide
-   :caption: User Guide
-   :glob:
-
-   pages/evaluate/metrics/*
+   
diff --git a/docs/source/pages/evaluate/fairness/fairness_evaluator.rst b/docs/source/pages/evaluate/fairness/fairness_evaluator.rst
@@ -0,0 +1,7 @@
+##################
+Fairness Evaluator
+##################
+
+evaluate_fairness
+^^^^^^^^^^^^^^^^^^
+.. autofunction:: cyclops.evaluate.fairness.evaluator.evaluate_fairness
diff --git a/docs/source/pages/evaluate/index.rst b/docs/source/pages/evaluate/index.rst
@@ -0,0 +1,9 @@
+Evaluation
+^^^^^^^^^^
+
+.. toctree::
+    :maxdepth: 2
+    :glob:
+
+    metrics/*
+    fairness/*
diff --git a/docs/source/user_guide.rst b/docs/source/user_guide.rst
@@ -0,0 +1,6 @@
+User Guide
+==========
+
+.. toctree::
+
+   pages/evaluate/index
