Added new files. Now it is time to write documentation

cavalab · Jun 6, 2024 · 6be28de · 6be28de
1 parent 3112a18
commit 6be28de
Show file tree

Hide file tree

Showing 13 changed files with 65 additions and 6 deletions.
diff --git a/docs/cpp_api/archive.rst b/docs/cpp_api/archive.rst
@@ -0,0 +1,5 @@
+Archive
+=======
+
+.. doxygenclass:: Brush::Pop::Archive
+   :members:
diff --git a/docs/cpp_api/engine.rst b/docs/cpp_api/engine.rst
@@ -0,0 +1,9 @@
+Engine (and parameters)
+=======================
+
+.. doxygenclass:: Brush::Parameters
+   :members:
+
+.. doxygenclass:: Brush::Engine
+   :members:
+
diff --git a/docs/cpp_api/evaluation.rst b/docs/cpp_api/evaluation.rst
@@ -0,0 +1,8 @@
+Evaluation
+==========
+
+.. doxygenclass:: Brush::Eval::Evaluation
+   :members:
+
+.. doxygenclass:: Brush::Scorer
+   :members:
diff --git a/docs/cpp_api/index.md b/docs/cpp_api/index.md
@@ -13,5 +13,11 @@ search_space
 program
 node
 nodetypes
+individual
+evaluation
+population
 variation
+selection
+archive
+engine
 ```
diff --git a/docs/cpp_api/individual.rst b/docs/cpp_api/individual.rst
@@ -0,0 +1,8 @@
+Individual and Fitness
+======================
+
+.. doxygenclass:: Brush::Pop::Individual
+   :members:
+
+.. doxygenclass:: Brush::Fitness
+   :members:
diff --git a/docs/cpp_api/population.rst b/docs/cpp_api/population.rst
@@ -0,0 +1,5 @@
+Population
+==========
+
+.. doxygenclass:: Brush::Pop::Population
+   :members:
diff --git a/docs/cpp_api/selection.rst b/docs/cpp_api/selection.rst
@@ -0,0 +1,14 @@
+Selection
+=========
+
+.. doxygenclass:: Brush::Sel::Selection
+   :members:
+
+.. doxygenclass:: Brush::Sel::SelectionOperator
+   :members:
+
+.. doxygenclass:: Brush::Sel::NSGA2
+   :members:
+
+.. doxygenclass:: Brush::Sel::Lexicase
+   :members:
diff --git a/docs/cpp_api/variation.rst b/docs/cpp_api/variation.rst
@@ -1,4 +1,8 @@
 Variation (Crossover/Mutation)
 ==============================
 
-.. doxygenfile:: variation.h
+.. doxygenclass:: Brush::Vary::MutationBase
+   :members:
+
+.. doxygenclass:: Brush::Vary::Variation
+   :members:
diff --git a/docs/python_api/classifier.rst b/docs/python_api/classifier.rst
@@ -1,7 +1,6 @@
 BrushClassifier
 ===============
 
-
-.. autoclass:: brush.estimator.BrushClassifier
+.. autoclass:: pybrush.BrushClassifier
    :members:
    :undoc-members:
diff --git a/docs/python_api/estimator.rst b/docs/python_api/estimator.rst
@@ -1,6 +1,6 @@
 BrushEstimator
 ==============
 
-.. autoclass:: brush.estimator.BrushEstimator
+.. autoclass:: pybrush.BrushEstimator
    :members:
    :undoc-members:
diff --git a/docs/python_api/index.md b/docs/python_api/index.md
@@ -4,4 +4,5 @@
 estimator
 regressor
 classifier
+python_api
 ```
diff --git a/docs/python_api/python_api.rst b/docs/python_api/python_api.rst
@@ -3,7 +3,7 @@ Python API
 
 .. With doxygennamespace:
 
-.. .. doxygennamespace:: brush
+.. .. doxygennamespace:: pybrush
 ..    :members: 
 
 
diff --git a/docs/python_api/regressor.rst b/docs/python_api/regressor.rst
@@ -1,6 +1,6 @@
 BrushRegressor
 ==============
 
-.. autoclass:: brush.estimator.BrushRegressor
+.. autoclass:: pybrush.BrushRegressor
    :members:
    :undoc-members: