update docs

multi-objective · Nov 13, 2023 · 160202e · 160202e
1 parent 19ab29b
commit 160202e
Show file tree

Hide file tree

Showing 19 changed files with 44 additions and 437 deletions.
diff --git a/python/Makefile b/python/Makefile
@@ -10,6 +10,7 @@ test:
 	tox
 
 doc:
+	$(MAKE) -C doc clean
 	tox -e docs
 	$(MAKE) -C doc html
 

diff --git a/python/doc/api/eafpy.colour.rst b/python/doc/api/eafpy.colour.rst
diff --git a/python/doc/api/eafpy.eaf.rst b/python/doc/api/eafpy.eaf.rst
diff --git a/python/doc/api/eafpy.plot.rst b/python/doc/api/eafpy.plot.rst
diff --git a/python/doc/api/index.rst b/python/doc/api/index.rst
@@ -9,5 +9,5 @@ API reference
 .. toctree::
    :maxdepth: 2
 
-   eafpy
+   moocore
 
diff --git a/python/doc/api/moocore.moocore.rst b/python/doc/api/moocore.moocore.rst
@@ -0,0 +1,7 @@
+moocore.moocore module
+======================
+
+.. automodule:: moocore.moocore
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/python/doc/api/eafpy.rst → python/doc/api/moocore.rst b/python/doc/api/eafpy.rst → python/doc/api/moocore.rst
@@ -1,7 +1,7 @@
-eafpy package
-=============
+moocore package
+===============
 
-.. automodule:: eafpy
+.. automodule:: moocore
    :members:
    :undoc-members:
    :show-inheritance:
@@ -12,6 +12,4 @@ Submodules
 .. toctree::
    :maxdepth: 4
 
-   eafpy.colour
-   eafpy.eaf
-   eafpy.plot
+   moocore.moocore
diff --git a/python/doc/conf.py b/python/doc/conf.py
@@ -6,10 +6,10 @@
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 from datetime import date
-import eafpy as eaf
+import moocore
 
-project = "eafpy"
-_full_version = eaf.__version__
+project = "moocore"
+_full_version = moocore.__version__
 release = _full_version.split("+", 1)[0]
 version = ".".join(release.split(".")[:2])
 year = date.today().year
@@ -40,7 +40,7 @@
             # Label for this link
             "name": "GitHub",
             # URL where the link will redirect
-            "url": "https://github.com/auto-optimization/eafpy",  # required
+            "url": "https://github.com/auto-optimization/moocore",  # required
             # Icon class (if "type": "fontawesome"), or path to local image (if "type": "local")
             "icon": "fa-brands fa-square-github",
             # The type of image to be used (see below for details)
@@ -50,7 +50,7 @@
 }
 html_context = {
     "github_user": "auto-optimization",
-    "github_repo": "eafpy",
+    "github_repo": "moocoore",
     "github_version": "main",
     "doc_path": "doc",
 }

diff --git a/python/doc/eafpy.rst b/python/doc/eafpy.rst
diff --git a/python/doc/examples/eaf_plot.md b/python/doc/examples/eaf_plot.md
diff --git a/python/doc/examples/heatmap_prototype.md b/python/doc/examples/heatmap_prototype.md
diff --git a/python/doc/examples/index.rst b/python/doc/examples/index.rst
@@ -1,14 +1,10 @@
-.. _examples:
-
 Examples
 ========
 
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
 
-   plot_datasets_examples.md
-   style_plots.md
-   eaf_plot.md
-   heatmap_prototype.md
+   metrics.md
+
 
diff --git a/python/doc/examples/metrics.md b/python/doc/examples/metrics.md
@@ -0,0 +1,16 @@
+---
+file_format: mystnb
+kernelspec:
+  name: python3
+---
+# Unary quality metrics
+## Read data sets
+
+```{code-cell}
+import moocore as moo
+spherical = moo.read_datasets("spherical-250-10-3d.txt")
+uniform = moo.read_datasets("uniform-250-10-3d.txt")
+print(spherical.shape)
+print(uniform.shape)
+```
+
-Original file line number
+Diff line change
@@ Expand Up / @@ -10,6 +10,7 @@ test: @@
     	tox
     doc:
+    	$(MAKE) -C doc clean
     	tox -e docs
     	$(MAKE) -C doc html
@@ Expand Down @@