diff --git a/docs/source/api/algorithms/index.rst b/docs/source/api/algorithms/index.rst index 94efead1..6f9c79c8 100644 --- 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 \ No newline at end of file + mo/index diff --git a/docs/source/api/problems/index.rst b/docs/source/api/problems/index.rst index bd849336..c6ddb5c1 100644 --- 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 index ca700c04..b3c16d44 100644 --- 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 ` and :mod:`here `. .. code-block:: python