remove deploy + added API ref

DynaDojo · Dec 31, 2023 · 6d174a5 · 6d174a5
1 parent 2ef3596
commit 6d174a5
Show file tree

Hide file tree

Showing 46 changed files with 53 additions and 48 deletions.
diff --git a/docs/requirements.txt b/docs/requirements.txt
diff --git a/docs/source/_autosummary/dynadojo.abstractions.AbstractAlgorithm.rst b/docs/source/_autosummary/dynadojo.abstractions.AbstractAlgorithm.rst
@@ -1,4 +1,4 @@
-dynadojo.abstractions.AbstractAlgorithm
+dynadojo.abstractions.AbstractAlgorithm
 =======================================
 
 .. currentmodule:: dynadojo.abstractions

diff --git a/docs/source/_autosummary/dynadojo.abstractions.AbstractSystem.rst b/docs/source/_autosummary/dynadojo.abstractions.AbstractSystem.rst
@@ -1,4 +1,4 @@
-dynadojo.abstractions.AbstractSystem
+dynadojo.abstractions.AbstractSystem
 ====================================
 
 .. currentmodule:: dynadojo.abstractions

diff --git a/docs/source/_autosummary/dynadojo.abstractions.rst b/docs/source/_autosummary/dynadojo.abstractions.rst
@@ -1,4 +1,4 @@
-dynadojo.abstractions
+dynadojo.abstractions
 =====================
 
 .. automodule:: dynadojo.abstractions

diff --git a/docs/source/_autosummary/dynadojo.baselines.aug_ode.rst b/docs/source/_autosummary/dynadojo.baselines.aug_ode.rst
@@ -1,4 +1,4 @@
-dynadojo.baselines.aug\_ode
+dynadojo.baselines.aug\_ode
 ===========================
 
 .. automodule:: dynadojo.baselines.aug_ode

diff --git a/docs/source/_autosummary/dynadojo.baselines.cnn.rst b/docs/source/_autosummary/dynadojo.baselines.cnn.rst
@@ -1,4 +1,4 @@
-dynadojo.baselines.cnn
+dynadojo.baselines.cnn
 ======================
 
 .. automodule:: dynadojo.baselines.cnn

diff --git a/docs/source/_autosummary/dynadojo.baselines.dmd.rst b/docs/source/_autosummary/dynadojo.baselines.dmd.rst
@@ -1,4 +1,4 @@
-dynadojo.baselines.dmd
+dynadojo.baselines.dmd
 ======================
 
 .. automodule:: dynadojo.baselines.dmd

diff --git a/docs/source/_autosummary/dynadojo.baselines.dnn.rst b/docs/source/_autosummary/dynadojo.baselines.dnn.rst
@@ -1,4 +1,4 @@
-dynadojo.baselines.dnn
+dynadojo.baselines.dnn
 ======================
 
 .. automodule:: dynadojo.baselines.dnn

diff --git a/docs/source/_autosummary/dynadojo.baselines.lpr.rst b/docs/source/_autosummary/dynadojo.baselines.lpr.rst
@@ -1,4 +1,4 @@
-dynadojo.baselines.lpr
+dynadojo.baselines.lpr
 ======================
 
 .. automodule:: dynadojo.baselines.lpr

diff --git a/docs/source/_autosummary/dynadojo.baselines.lr.rst b/docs/source/_autosummary/dynadojo.baselines.lr.rst
@@ -1,4 +1,4 @@
-dynadojo.baselines.lr
+dynadojo.baselines.lr
 =====================
 
 .. automodule:: dynadojo.baselines.lr

diff --git a/docs/source/_autosummary/dynadojo.baselines.ode.rst b/docs/source/_autosummary/dynadojo.baselines.ode.rst
@@ -1,4 +1,4 @@
-dynadojo.baselines.ode
+dynadojo.baselines.ode
 ======================
 
 .. automodule:: dynadojo.baselines.ode

diff --git a/docs/source/_autosummary/dynadojo.baselines.rst b/docs/source/_autosummary/dynadojo.baselines.rst
@@ -1,4 +1,4 @@
-dynadojo.baselines
+dynadojo.baselines
 ==================
 
 .. automodule:: dynadojo.baselines

diff --git a/docs/source/_autosummary/dynadojo.challenges.Challenge.rst b/docs/source/_autosummary/dynadojo.challenges.Challenge.rst
@@ -1,4 +1,4 @@
-dynadojo.challenges.Challenge
+dynadojo.challenges.Challenge
 =============================
 
 .. currentmodule:: dynadojo.challenges

diff --git a/docs/source/_autosummary/dynadojo.challenges.FixedComplexity.rst b/docs/source/_autosummary/dynadojo.challenges.FixedComplexity.rst
@@ -1,4 +1,4 @@
-dynadojo.challenges.FixedComplexity
+dynadojo.challenges.FixedComplexity
 ===================================
 
 .. currentmodule:: dynadojo.challenges

diff --git a/docs/source/_autosummary/dynadojo.challenges.FixedError.rst b/docs/source/_autosummary/dynadojo.challenges.FixedError.rst
@@ -1,4 +1,4 @@
-dynadojo.challenges.FixedError
+dynadojo.challenges.FixedError
 ==============================
 
 .. currentmodule:: dynadojo.challenges

diff --git a/docs/source/_autosummary/dynadojo.challenges.FixedTrainSize.rst b/docs/source/_autosummary/dynadojo.challenges.FixedTrainSize.rst
@@ -1,4 +1,4 @@
-dynadojo.challenges.FixedTrainSize
+dynadojo.challenges.FixedTrainSize
 ==================================
 
 .. currentmodule:: dynadojo.challenges

diff --git a/docs/source/_autosummary/dynadojo.challenges.rst b/docs/source/_autosummary/dynadojo.challenges.rst
@@ -1,4 +1,4 @@
-dynadojo.challenges
+dynadojo.challenges
 ===================
 
 .. automodule:: dynadojo.challenges

diff --git a/docs/source/_autosummary/dynadojo.systems.ca.rst b/docs/source/_autosummary/dynadojo.systems.ca.rst
@@ -1,4 +1,4 @@
-dynadojo.systems.ca
+dynadojo.systems.ca
 ===================
 
 .. automodule:: dynadojo.systems.ca

diff --git a/docs/source/_autosummary/dynadojo.systems.ctln.rst b/docs/source/_autosummary/dynadojo.systems.ctln.rst
@@ -1,4 +1,4 @@
-dynadojo.systems.ctln
+dynadojo.systems.ctln
 =====================
 
 .. automodule:: dynadojo.systems.ctln

diff --git a/docs/source/_autosummary/dynadojo.systems.epidemic.rst b/docs/source/_autosummary/dynadojo.systems.epidemic.rst
@@ -1,4 +1,4 @@
-dynadojo.systems.epidemic
+dynadojo.systems.epidemic
 =========================
 
 .. automodule:: dynadojo.systems.epidemic

diff --git a/docs/source/_autosummary/dynadojo.systems.fbsnn_pde.rst b/docs/source/_autosummary/dynadojo.systems.fbsnn_pde.rst
@@ -1,4 +1,4 @@
-dynadojo.systems.fbsnn\_pde
+dynadojo.systems.fbsnn\_pde
 ===========================
 
 .. automodule:: dynadojo.systems.fbsnn_pde

diff --git a/docs/source/_autosummary/dynadojo.systems.heat.rst b/docs/source/_autosummary/dynadojo.systems.heat.rst
@@ -1,4 +1,4 @@
-dynadojo.systems.heat
+dynadojo.systems.heat
 =====================
 
 .. automodule:: dynadojo.systems.heat

diff --git a/docs/source/_autosummary/dynadojo.systems.kuramoto.rst b/docs/source/_autosummary/dynadojo.systems.kuramoto.rst
@@ -1,4 +1,4 @@
-dynadojo.systems.kuramoto
+dynadojo.systems.kuramoto
 =========================
 
 .. automodule:: dynadojo.systems.kuramoto

diff --git a/docs/source/_autosummary/dynadojo.systems.lds.rst b/docs/source/_autosummary/dynadojo.systems.lds.rst
@@ -1,4 +1,4 @@
-dynadojo.systems.lds
+dynadojo.systems.lds
 ====================
 
 .. automodule:: dynadojo.systems.lds

diff --git a/docs/source/_autosummary/dynadojo.systems.lorenz.rst b/docs/source/_autosummary/dynadojo.systems.lorenz.rst
@@ -1,4 +1,4 @@
-dynadojo.systems.lorenz
+dynadojo.systems.lorenz
 =======================
 
 .. automodule:: dynadojo.systems.lorenz

diff --git a/docs/source/_autosummary/dynadojo.systems.lv.rst b/docs/source/_autosummary/dynadojo.systems.lv.rst
@@ -1,4 +1,4 @@
-dynadojo.systems.lv
+dynadojo.systems.lv
 ===================
 
 .. automodule:: dynadojo.systems.lv

diff --git a/docs/source/_autosummary/dynadojo.systems.opinion.rst b/docs/source/_autosummary/dynadojo.systems.opinion.rst
@@ -1,4 +1,4 @@
-dynadojo.systems.opinion
+dynadojo.systems.opinion
 ========================
 
 .. automodule:: dynadojo.systems.opinion

diff --git a/docs/source/_autosummary/dynadojo.systems.rst b/docs/source/_autosummary/dynadojo.systems.rst
@@ -1,4 +1,4 @@
-dynadojo.systems
+dynadojo.systems
 ================
 
 .. automodule:: dynadojo.systems

diff --git a/docs/source/_autosummary/dynadojo.systems.santi.rst b/docs/source/_autosummary/dynadojo.systems.santi.rst
@@ -1,4 +1,4 @@
-dynadojo.systems.santi
+dynadojo.systems.santi
 ======================
 
 .. automodule:: dynadojo.systems.santi

diff --git a/docs/source/_autosummary/dynadojo.systems.snn.rst b/docs/source/_autosummary/dynadojo.systems.snn.rst
@@ -1,4 +1,4 @@
-dynadojo.systems.snn
+dynadojo.systems.snn
 ====================
 
 .. automodule:: dynadojo.systems.snn

diff --git a/docs/source/_autosummary/dynadojo.systems.utils.rst b/docs/source/_autosummary/dynadojo.systems.utils.rst
@@ -1,4 +1,4 @@
-dynadojo.systems.utils
+dynadojo.systems.utils
 ======================
 
 .. automodule:: dynadojo.systems.utils

diff --git a/docs/source/_autosummary/dynadojo.utils.ca.rst b/docs/source/_autosummary/dynadojo.utils.ca.rst
@@ -1,4 +1,4 @@
-dynadojo.utils.ca
+dynadojo.utils.ca
 =================
 
 .. automodule:: dynadojo.utils.ca

diff --git a/docs/source/_autosummary/dynadojo.utils.fbsnn_pde.rst b/docs/source/_autosummary/dynadojo.utils.fbsnn_pde.rst
@@ -1,4 +1,4 @@
-dynadojo.utils.fbsnn\_pde
+dynadojo.utils.fbsnn\_pde
 =========================
 
 .. automodule:: dynadojo.utils.fbsnn_pde

diff --git a/docs/source/_autosummary/dynadojo.utils.heat.rst b/docs/source/_autosummary/dynadojo.utils.heat.rst
@@ -1,4 +1,4 @@
-dynadojo.utils.heat
+dynadojo.utils.heat
 ===================
 
 .. automodule:: dynadojo.utils.heat

diff --git a/docs/source/_autosummary/dynadojo.utils.kuramoto.rst b/docs/source/_autosummary/dynadojo.utils.kuramoto.rst
@@ -1,4 +1,4 @@
-dynadojo.utils.kuramoto
+dynadojo.utils.kuramoto
 =======================
 
 .. automodule:: dynadojo.utils.kuramoto

diff --git a/docs/source/_autosummary/dynadojo.utils.lds.rst b/docs/source/_autosummary/dynadojo.utils.lds.rst
@@ -1,4 +1,4 @@
-dynadojo.utils.lds
+dynadojo.utils.lds
 ==================
 
 .. automodule:: dynadojo.utils.lds

diff --git a/docs/source/_autosummary/dynadojo.utils.lv.rst b/docs/source/_autosummary/dynadojo.utils.lv.rst
@@ -1,4 +1,4 @@
-dynadojo.utils.lv
+dynadojo.utils.lv
 =================
 
 .. automodule:: dynadojo.utils.lv

diff --git a/docs/source/_autosummary/dynadojo.utils.opinion.rst b/docs/source/_autosummary/dynadojo.utils.opinion.rst
@@ -1,4 +1,4 @@
-dynadojo.utils.opinion
+dynadojo.utils.opinion
 ======================
 
 .. automodule:: dynadojo.utils.opinion

diff --git a/docs/source/_autosummary/dynadojo.utils.plotting.rst b/docs/source/_autosummary/dynadojo.utils.plotting.rst
@@ -1,4 +1,4 @@
-dynadojo.utils.plotting
+dynadojo.utils.plotting
 =======================
 
 .. automodule:: dynadojo.utils.plotting

diff --git a/docs/source/_autosummary/dynadojo.utils.rst b/docs/source/_autosummary/dynadojo.utils.rst
@@ -1,4 +1,4 @@
-dynadojo.utils
+dynadojo.utils
 ==============
 
 .. automodule:: dynadojo.utils

diff --git a/docs/source/_autosummary/dynadojo.utils.seeding.rst b/docs/source/_autosummary/dynadojo.utils.seeding.rst
@@ -1,4 +1,4 @@
-dynadojo.utils.seeding
+dynadojo.utils.seeding
 ======================
 
 .. automodule:: dynadojo.utils.seeding

diff --git a/docs/source/_autosummary/dynadojo.wrappers.AlgorithmChecker.rst b/docs/source/_autosummary/dynadojo.wrappers.AlgorithmChecker.rst
@@ -1,4 +1,4 @@
-dynadojo.wrappers.AlgorithmChecker
+dynadojo.wrappers.AlgorithmChecker
 ==================================
 
 .. currentmodule:: dynadojo.wrappers

diff --git a/docs/source/_autosummary/dynadojo.wrappers.SystemChecker.rst b/docs/source/_autosummary/dynadojo.wrappers.SystemChecker.rst
@@ -1,4 +1,4 @@
-dynadojo.wrappers.SystemChecker
+dynadojo.wrappers.SystemChecker
 ===============================
 
 .. currentmodule:: dynadojo.wrappers

diff --git a/docs/source/_autosummary/dynadojo.wrappers.rst b/docs/source/_autosummary/dynadojo.wrappers.rst
@@ -1,4 +1,4 @@
-dynadojo.wrappers
+dynadojo.wrappers
 =================
 
 .. automodule:: dynadojo.wrappers

diff --git a/docs/source/api-reference.rst b/docs/source/api-reference.rst
@@ -0,0 +1,8 @@
+API Reference
+===============
+
+.. toctree::
+   :maxdepth: 2
+
+   _autosummary/dynadojo
+
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,14 +1,12 @@
-DynaDojo Documentation
+DynaDojo documentation
 =======================
 
 **Release**: |release|
 
 .. toctree::
    :maxdepth: 2
-   :caption: Docs
 
    getting-started
    user-guide/index
-   _autosummary/dynadojo
-
+   api-reference