add cross-ref for algorithms and problems

EMI-Group · Feb 9, 2023 · 50df688 · 50df688
1 parent e046b38
commit 50df688
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 6 deletions.
diff --git a/docs/source/api/algorithms/index.rst b/docs/source/api/algorithms/index.rst
@@ -2,8 +2,10 @@
 Algorithms
 ==========
 
+.. automodule:: evox.algorithms
+
 .. toctree::
     :maxdepth: 2
 
     so/index
-    mo/index
+    mo/index
diff --git a/docs/source/api/problems/index.rst b/docs/source/api/problems/index.rst
@@ -2,6 +2,8 @@
 Problems
 ========
 
+.. automodule:: evox.problems
+
 .. toctree::
     :maxdepth: 2
 

diff --git a/docs/source/guide/basics/1-start.rst b/docs/source/guide/basics/1-start.rst
@@ -1,8 +1,7 @@
-===============
-Getting Started
-===============
+===========
+Quick Start
+===========
 
-=============================
 Algorithm, Problem & Pipeline
 =============================
 
@@ -13,7 +12,8 @@ To start with, import ``evox``
     import evox
     from evox import algorithms, problems, pipelines
 
-Then, create an ``algorithm`` and a ``problem``:
+Then, create an ``algorithm`` and a ``problem``.
+The list of available algorithms and problems can be found in :mod:`here <evox.algorithms>` and :mod:`here <evox.problems>`.
 
 .. code-block:: python