Update docs and their template

mork-optimization · Oct 9, 2024 · d473c1d · d473c1d
1 parent dedf8e5
commit d473c1d
Show file tree

Hide file tree

Showing 8 changed files with 220 additions and 126 deletions.
diff --git a/docs/examples/.pages b/docs/examples/.pages
@@ -0,0 +1 @@
+title: Step-by-step examples
diff --git a/docs/examples/TSP.md b/docs/examples/TSP.md
diff --git a/example-tsp/src/main/java/es/urjc/etsii/grafo/TSP/experiments/IraceExperiment.java b/example-tsp/src/main/java/es/urjc/etsii/grafo/TSP/experiments/IraceExperiment.java
@@ -1,8 +1,8 @@
 package es.urjc.etsii.grafo.TSP.experiments;
 
 import es.urjc.etsii.grafo.TSP.algorithms.constructives.TSPRandomConstructive;
-import es.urjc.etsii.grafo.TSP.algorithms.neighborhood.InsertNeighborhood;
-import es.urjc.etsii.grafo.TSP.algorithms.neighborhood.SwapNeighborhood;
+import es.urjc.etsii.grafo.TSP.model.neighs.InsertNeighborhood;
+import es.urjc.etsii.grafo.TSP.model.neighs.SwapNeighborhood;
 import es.urjc.etsii.grafo.TSP.model.TSPInstance;
 import es.urjc.etsii.grafo.TSP.model.TSPSolution;
 import es.urjc.etsii.grafo.algorithms.Algorithm;

diff --git a/example-tsp/src/main/java/es/urjc/etsii/grafo/TSP/experiments/LocalSearchExperiment.java b/example-tsp/src/main/java/es/urjc/etsii/grafo/TSP/experiments/LocalSearchExperiment.java
@@ -1,8 +1,8 @@
 package es.urjc.etsii.grafo.TSP.experiments;
 
 import es.urjc.etsii.grafo.TSP.algorithms.constructives.TSPRandomConstructive;
-import es.urjc.etsii.grafo.TSP.algorithms.neighborhood.InsertNeighborhood;
-import es.urjc.etsii.grafo.TSP.algorithms.neighborhood.SwapNeighborhood;
+import es.urjc.etsii.grafo.TSP.model.neighs.InsertNeighborhood;
+import es.urjc.etsii.grafo.TSP.model.neighs.SwapNeighborhood;
 import es.urjc.etsii.grafo.TSP.model.TSPInstance;
 import es.urjc.etsii.grafo.TSP.model.TSPSolution;
 import es.urjc.etsii.grafo.algorithms.Algorithm;

diff --git a/...thms/neighborhood/InsertNeighborhood.java → .../TSP/model/neighs/InsertNeighborhood.java b/...thms/neighborhood/InsertNeighborhood.java → .../TSP/model/neighs/InsertNeighborhood.java
@@ -1,4 +1,4 @@
-package es.urjc.etsii.grafo.TSP.algorithms.neighborhood;
+package es.urjc.etsii.grafo.TSP.model.neighs;
 
 import es.urjc.etsii.grafo.TSP.model.TSPBaseMove;
 import es.urjc.etsii.grafo.TSP.model.TSPInstance;
@@ -40,7 +40,7 @@ public InsertMove(TSPSolution solution, int pi, int pj) {
             super(solution);
             this.pi = pi;
             this.pj = pj;
-            this.distanceDelta = calculateValue(solution);
+            this.distanceDelta = insertDelta(solution);
         }
 
         @Override
@@ -49,7 +49,7 @@ protected TSPSolution _execute(TSPSolution solution) {
             return solution;
         }
 
-        private double calculateValue(TSPSolution solution){
+        private double insertDelta(TSPSolution solution){
             var s = solution.cloneSolution();
             s.insertLocationAtPiInPj(pi, pj);
             return s.getDistance() - solution.getDistance();

diff --git a/...rithms/neighborhood/SwapNeighborhood.java → ...fo/TSP/model/neighs/SwapNeighborhood.java b/...rithms/neighborhood/SwapNeighborhood.java → ...fo/TSP/model/neighs/SwapNeighborhood.java
@@ -1,4 +1,4 @@
-package es.urjc.etsii.grafo.TSP.algorithms.neighborhood;
+package es.urjc.etsii.grafo.TSP.model.neighs;
 
 import es.urjc.etsii.grafo.TSP.model.TSPBaseMove;
 import es.urjc.etsii.grafo.TSP.model.TSPInstance;

diff --git a/mkdocs-requirements.txt b/mkdocs-requirements.txt
@@ -1,3 +1,4 @@
 mkdocs-mermaid2-plugin
 Pygments
 mkdocs-awesome-pages-plugin
+mkdocs-material
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -1,6 +1,7 @@
+# yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json
 site_name: "Mork Developers Guide"
 theme:
-    name: "readthedocs"
+    name: "material"
     features:
         - content.code.select
         - content.code.annotate
@@ -14,6 +15,9 @@ markdown_extensions:
     - pymdownx.details
     - pymdownx.superfences
     - attr_list
+    - pymdownx.emoji:
+        emoji_index: !!python/name:material.extensions.emoji.twemoji
+        emoji_generator: !!python/name:material.extensions.emoji.to_svg
     - md_in_html
     - pymdownx.arithmatex:
         generic: true