Project-Platypus · dhadka · Sep 12, 2024 · Sep 11, 2024 · Sep 11, 2024 · Sep 11, 2024
diff --git a/.gitignore b/.gitignore
@@ -7,5 +7,6 @@ Platypus.egg-info/
 Platypus_Opt.egg-info/
 build/
 dist/
+docs/_build/
 .ipynb_checkpoints/
 .idea
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -7,6 +7,14 @@ build:
   os: ubuntu-lts-latest
   tools:
     python: latest
+  apt_packages:
+    - mpi
+    - mpich
+    - libmpich-dev
+    - libopenmpi-dev
+  jobs:
+    post_create_environment:
+      - pip install .[full]
 
 sphinx:
   configuration: docs/conf.py
diff --git a/docs/api/platypus.algorithms.rst b/docs/api/platypus.algorithms.rst
@@ -0,0 +1,6 @@
+platypus.algorithms module
+==========================
+
+.. automodule:: platypus.algorithms
+   :members:
+
diff --git a/docs/api/platypus.config.rst b/docs/api/platypus.config.rst
@@ -0,0 +1,8 @@
+platypus.config module
+======================
+
+.. automodule:: platypus.config
+   :members:
+   :private-members:
+
+   .. autoattribute:: platypus.config.PlatypusConfig
diff --git a/docs/api/platypus.core.rst b/docs/api/platypus.core.rst
@@ -0,0 +1,5 @@
+platypus.core module
+====================
+
+.. automodule:: platypus.core
+   :members:
diff --git a/docs/api/platypus.distance.rst b/docs/api/platypus.distance.rst
@@ -0,0 +1,5 @@
+platypus.distance module
+========================
+
+.. automodule:: platypus.distance
+   :members:
diff --git a/docs/api/platypus.errors.rst b/docs/api/platypus.errors.rst
@@ -0,0 +1,5 @@
+platypus.errors module
+======================
+
+.. automodule:: platypus.errors
+   :members:
diff --git a/docs/api/platypus.evaluator.rst b/docs/api/platypus.evaluator.rst
@@ -0,0 +1,5 @@
+platypus.evaluator module
+=========================
+
+.. automodule:: platypus.evaluator
+   :members:
diff --git a/docs/api/platypus.experimenter.rst b/docs/api/platypus.experimenter.rst
@@ -0,0 +1,5 @@
+platypus.experimenter module
+============================
+
+.. automodule:: platypus.experimenter
+   :members:
diff --git a/docs/api/platypus.filters.rst b/docs/api/platypus.filters.rst
@@ -0,0 +1,5 @@
+platypus.filters module
+=======================
+
+.. automodule:: platypus.filters
+   :members:
diff --git a/docs/api/platypus.indicators.rst b/docs/api/platypus.indicators.rst
@@ -0,0 +1,5 @@
+platypus.indicators module
+==========================
+
+.. automodule:: platypus.indicators
+   :members:
diff --git a/docs/api/platypus.io.rst b/docs/api/platypus.io.rst
@@ -0,0 +1,5 @@
+platypus.io module
+==================
+
+.. automodule:: platypus.io
+   :members:
diff --git a/docs/api/platypus.mpipool.rst b/docs/api/platypus.mpipool.rst
@@ -0,0 +1,5 @@
+platypus.mpipool module
+==========================
+
+.. automodule:: platypus.mpipool
+   :members:
diff --git a/docs/api/platypus.operators.rst b/docs/api/platypus.operators.rst
@@ -0,0 +1,6 @@
+platypus.operators module
+=========================
+
+.. automodule:: platypus.operators
+   :members:
+   :exclude-members: mutate, evolve, generate, select
diff --git a/docs/api/platypus.problems.rst b/docs/api/platypus.problems.rst
@@ -0,0 +1,7 @@
+platypus.problems module
+========================
+
+.. automodule:: platypus.problems
+   :members:
+   :undoc-members:
+   :exclude-members: evaluate, random, LAM, LB, UB, M
diff --git a/docs/api/platypus.rst b/docs/api/platypus.rst
@@ -0,0 +1,21 @@
+Platypus API
+============
+
+.. toctree::
+   :maxdepth: 2
+
+   platypus.algorithms
+   platypus.config
+   platypus.core
+   platypus.distance
+   platypus.errors
+   platypus.evaluator
+   platypus.experimenter
+   platypus.filters
+   platypus.indicators
+   platypus.io
+   platypus.mpipool
+   platypus.operators
+   platypus.problems
+   platypus.types
+   platypus.weights
diff --git a/docs/api/platypus.types.rst b/docs/api/platypus.types.rst
@@ -0,0 +1,5 @@
+platypus.types module
+=====================
+
+.. automodule:: platypus.types
+   :members:
diff --git a/docs/api/platypus.weights.rst b/docs/api/platypus.weights.rst
@@ -0,0 +1,5 @@
+platypus.weights module
+=======================
+
+.. automodule:: platypus.weights
+   :members:
diff --git a/docs/conf.py b/docs/conf.py
@@ -17,6 +17,7 @@
     'sphinx.ext.autodoc',
     'sphinx.ext.doctest',
     'sphinx.ext.imgmath',
+    'sphinx_rtd_theme',
 ]
 
 templates_path = ['_templates']
@@ -27,5 +28,11 @@
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-html_theme = 'alabaster'
+html_theme = 'sphinx_rtd_theme'
 html_static_path = ['_static']
+
+# The initial api/ contents were created with:
+#   sphinx-apidoc --separate --remove-old --no-toc -o docs/api platypus "*test*"
+#
+# Build these docs locally with:
+#   sphinx-build -M html . _build
diff --git a/docs/index.rst b/docs/index.rst
@@ -14,3 +14,4 @@ optimization.
    getting-started
    types
    experimenter
+   api/platypus