Renamed files for convenience

JuliaConstraints · Aug 7, 2024 · cdafa88 · cdafa88
1 parent b617c80
commit cdafa88
Show file tree

Hide file tree

Showing 51 changed files with 58 additions and 99 deletions.
diff --git a/docs/make.jl b/docs/make.jl
@@ -14,6 +14,7 @@ using ConstraintModels
 # Learning
 using CompositionalNetworks
 using QUBOConstraints
+# using ConstraintsTranslator
 using ConstraintLearning
 
 # Constraint-Based Local Search
@@ -28,6 +29,7 @@ makedocs(;
         PerfChecker,
         ConstraintCommons, ConstraintDomains, Constraints, ConstraintModels,
         CompositionalNetworks, QUBOConstraints, ConstraintLearning,
+        # CompositionalNetworks, QUBOConstraints, ConstraintsTranslator, ConstraintLearning,
         LocalSearchSolvers, CBLS,
         MetaStrategist,
     ],
@@ -45,81 +47,82 @@ makedocs(;
         "Home" => "index.md",
         "Constraint Programming" => [
             "Part 1: Basics" => [
-                "Introduction" => "cp/intro.md",
-                "CP 101" => "cp/cp101.md",
-                "Optimization(s)?" => "cp/opt.md",
-                "Getting Started" => "cp/getting_started.md",
-                "Ecosystem" => "cp/ecosystem.md",
+                "Introduction" => "cp/00_intro.md",
+                "CP 101" => "cp/10_cp101.md",
+                "Optimization(s)?" => "cp/20_opt.md",
+                "Getting Started" => "cp/30_getting_started.md",
+                "Ecosystem" => "cp/40_ecosystem.md",
             ],
             "Part 2: Advanced" => [
-                "CP Techniques" => "cp/advanced.md",
-                "Applications" => "cp/applications.md",
-                "Models" => "cp/models.md",
-                "Tutorials&XP" => "cp/tuto_xp.md",
-                "Contributing" => "cp/contribution.md",
+                "CP Techniques" => "cp/50_advanced.md",
+                "Applications" => "cp/60_applications.md",
+                "Models" => "cp/70_models.md",
+                "Tutorials&XP" => "cp/80_tuto_xp.md",
+                "Contributing" => "cp/90_contribution.md",
             ],
         ],
         "Modeling Toolkit" => [
-            "Introduction" => "constraints/intro.md",
-            "Variables and Domains" => "constraints/variables_and_domains.md",
+            "Introduction" => "constraints/00_intro.md",
+            "Variables and Domains" => "constraints/10_variables_and_domains.md",
             "Constraints" => [
-                "Basics" => "constraints/constraints.md",
-                "Generic Constraints" => "constraints/generic_constraints.md",
-                "Language Constraints" => "constraints/language_constraints.md",
-                "Comparison Constraints" => "constraints/comparison_constraints.md",
-                "Counting and Summing Constraints" => "constraints/counting_summing_constraints.md",
-                "Connection Constraints" => "constraints/connection_constraints.md",
-                "Packing and Scheduling Constraints" => "constraints/packing_scheduling_constraints.md",
-                "Graph Constraints" => "constraints/graph_constraints.md",
-                "Elementary Constraints" => "constraints/elementary_constraints.md",
+                "Basics" => "constraints/20_constraints.md",
+                "Generic Constraints" => "constraints/21_generic_constraints.md",
+                "Language Constraints" => "constraints/22_language_constraints.md",
+                "Comparison Constraints" => "constraints/23_comparison_constraints.md",
+                "Counting and Summing Constraints" => "constraints/24_counting_summing_constraints.md",
+                "Connection Constraints" => "constraints/25_connection_constraints.md",
+                "Packing and Scheduling Constraints" => "constraints/26_packing_scheduling_constraints.md",
+                "Graph Constraints" => "constraints/27_graph_constraints.md",
+                "Elementary Constraints" => "constraints/28_elementary_constraints.md",
             ],
-            "Model Catalog" => "constraints/constraint_models.md",
+            "Model Catalog" => "constraints/40_constraint_models.md",
             "Internals" => [
-                "ConstraintCommons.jl" => "constraints/constraint_commons.md",
-                "ConstraintDomains.jl" => "constraints/constraint_domains.md",
-                "Constraints.jl" => "constraints/constraints_jl.md",
+                "ConstraintCommons.jl" => "constraints/60_constraint_commons.md",
+                "ConstraintDomains.jl" => "constraints/61_constraint_domains.md",
+                "Constraints.jl" => "constraints/62_constraints_jl.md",
             ],
         ],
         "Learning" => [
-            "Introduction" => "learning/intro.md",
+            "Introduction" => "learning/00_intro.md",
             "CompositionalNetworks.jl" => [
-                "About ICNs" => "learning/compositional_networks.md",
-                "Layers" => "learning/layers.md",
-                "Transformations Layer" => "learning/transformation.md",
-                "Arithmetic Layer" => "learning/arithmetic.md",
-                "Aggregation Layer" => "learning/aggregation.md",
-                "Comparison Layer" => "learning/comparison.md",
+                "About ICNs" => "learning/10_compositional_networks.md",
+                "Layers" => "learning/11_layers.md",
+                "Transformations Layer" => "learning/12_transformation.md",
+                "Arithmetic Layer" => "learning/13_arithmetic.md",
+                "Aggregation Layer" => "learning/14_aggregation.md",
+                "Comparison Layer" => "learning/15_comparison.md",
             ],
             "QUBOConstraints.jl" => [
-                "Model as QUBO" => "learning/qubo_constraints.md",
-                "Encoding" => "learning/qubo_encoding.md",
-                "Learning" => "learning/qubo_learning.md",
+                "Model as QUBO" => "learning/20_qubo_constraints.md",
+                "Encoding" => "learning/21_qubo_encoding.md",
+                "Learning" => "learning/22_qubo_learning.md",
             ],
-            "ConstraintLearning.jl" => "learning/constraint_learning.md",
+            "ConstraintsTranslator.jl" => "learning/30_constraints_translator.md",
+            "ConstraintLearning.jl" => "learning/90_constraint_learning.md",
         ],
         "Solvers" => [
-            "Introduction" => "solvers/intro.md",
+            "Introduction" => "solvers/00_intro.md",
             "JuMPed" => [
-                "CBLS.jl" => "solvers/cbls.md",
+                "CBLS.jl" => "solvers/10_cbls.md",
             ],
             "Others" => [
-                "LocalSearchSolvers.jl" => "solvers/local_search_solvers.md",
+                "LocalSearchSolvers.jl" => "solvers/60_local_search_solvers.md",
             ],
         ],
         "Meta Strategist" => [
-            "MetaStrategist.jl" => "meta/meta_strategist.md",
+            "MetaStrategist.jl" => "meta/00_meta_strategist.md",
         ],
         "Performance Checking" => [
-            "PerfChecker.jl" => "perf/perf_checker.md",
-            "Tutorial" => "perf/tutorial.md",
-            "Interface" => "perf/perf_interface.md",
-            "BenchmarkToolsExt" => "perf/benchmark_ext.md",
-            "ChairmarksExt" => "perf/chairmarks_ext.md",
-            "API" => "perf/api.md"
+            "PerfChecker.jl" => "perf/00_perf_checker.md",
+            "Tutorial" => "perf/10_tutorial.md",
+            "Interface" => "perf/20_perf_interface.md",
+            "BenchmarkToolsExt" => "perf/30_benchmark_ext.md",
+            "ChairmarksExt" => "perf/40_chairmarks_ext.md",
+            "API" => "perf/90_api.md"
         ],
         "API" => [
-            "Public" => "public_api.md",
-            "Full" => "full_api.md",
+            "Public" => "api/00_public.md",
+            "Full" => "api/10_full.md",
         ],
     ],
     warnonly=true,

diff --git a/docs/src/public_api.md → docs/src/api/00_public.md b/docs/src/public_api.md → docs/src/api/00_public.md
diff --git a/docs/src/full_api.md → docs/src/api/10_full.md b/docs/src/full_api.md → docs/src/api/10_full.md
diff --git a/docs/src/constraints/intro.md → docs/src/constraints/00_intro.md b/docs/src/constraints/intro.md → docs/src/constraints/00_intro.md
diff --git a/.../src/constraints/variables_and_domains.md → ...c/constraints/10_variables_and_domains.md b/.../src/constraints/variables_and_domains.md → ...c/constraints/10_variables_and_domains.md
diff --git a/docs/src/constraints/constraints.md → docs/src/constraints/20_constraints.md b/docs/src/constraints/constraints.md → docs/src/constraints/20_constraints.md
diff --git a/docs/src/constraints/generic_constraints.md → ...src/constraints/21_generic_constraints.md b/docs/src/constraints/generic_constraints.md → ...src/constraints/21_generic_constraints.md
diff --git a/docs/src/constraints/language_constraints.md → ...rc/constraints/22_language_constraints.md b/docs/src/constraints/language_constraints.md → ...rc/constraints/22_language_constraints.md
diff --git a/...src/constraints/comparison_constraints.md → .../constraints/23_comparison_constraints.md b/...src/constraints/comparison_constraints.md → .../constraints/23_comparison_constraints.md
diff --git a/...nstraints/counting_summing_constraints.md → ...raints/24_counting_summing_constraints.md b/...nstraints/counting_summing_constraints.md → ...raints/24_counting_summing_constraints.md
diff --git a/...src/constraints/connection_constraints.md → .../constraints/25_connection_constraints.md b/...src/constraints/connection_constraints.md → .../constraints/25_connection_constraints.md
diff --git a/...traints/packing_scheduling_constraints.md → ...ints/26_packing_scheduling_constraints.md b/...traints/packing_scheduling_constraints.md → ...ints/26_packing_scheduling_constraints.md
diff --git a/docs/src/constraints/graph_constraints.md → docs/src/constraints/27_graph_constraints.md b/docs/src/constraints/graph_constraints.md → docs/src/constraints/27_graph_constraints.md
diff --git a/...src/constraints/elementary_constraints.md → .../constraints/28_elementary_constraints.md b/...src/constraints/elementary_constraints.md → .../constraints/28_elementary_constraints.md
diff --git a/docs/src/constraints/constraint_models.md → docs/src/constraints/40_constraint_models.md b/docs/src/constraints/constraint_models.md → docs/src/constraints/40_constraint_models.md
diff --git a/docs/src/constraints/constraint_commons.md → .../src/constraints/60_constraint_commons.md b/docs/src/constraints/constraint_commons.md → .../src/constraints/60_constraint_commons.md
diff --git a/docs/src/constraints/constraint_domains.md → .../src/constraints/61_constraint_domains.md b/docs/src/constraints/constraint_domains.md → .../src/constraints/61_constraint_domains.md
diff --git a/docs/src/constraints/constraints_jl.md → docs/src/constraints/62_constraints_jl.md b/docs/src/constraints/constraints_jl.md → docs/src/constraints/62_constraints_jl.md
diff --git a/docs/src/cp/intro.md → docs/src/cp/00_intro.md b/docs/src/cp/intro.md → docs/src/cp/00_intro.md
diff --git a/docs/src/cp/cp101.md → docs/src/cp/10_cp101.md b/docs/src/cp/cp101.md → docs/src/cp/10_cp101.md
diff --git a/docs/src/cp/opt.md → docs/src/cp/20_opt.md b/docs/src/cp/opt.md → docs/src/cp/20_opt.md
diff --git a/docs/src/cp/getting_started.md → docs/src/cp/30_getting_started.md b/docs/src/cp/getting_started.md → docs/src/cp/30_getting_started.md
diff --git a/docs/src/cp/ecosystem.md → docs/src/cp/40_ecosystem.md b/docs/src/cp/ecosystem.md → docs/src/cp/40_ecosystem.md
diff --git a/docs/src/cp/advanced.md → docs/src/cp/50_advanced.md b/docs/src/cp/advanced.md → docs/src/cp/50_advanced.md
diff --git a/docs/src/cp/applications.md → docs/src/cp/60_applications.md b/docs/src/cp/applications.md → docs/src/cp/60_applications.md
diff --git a/docs/src/cp/models.md → docs/src/cp/70_models.md b/docs/src/cp/models.md → docs/src/cp/70_models.md
diff --git a/docs/src/cp/tuto_xp.md → docs/src/cp/80_tuto_xp.md b/docs/src/cp/tuto_xp.md → docs/src/cp/80_tuto_xp.md
diff --git a/docs/src/cp/contribution.md → docs/src/cp/90_contribution.md b/docs/src/cp/contribution.md → docs/src/cp/90_contribution.md
diff --git a/docs/src/index-old.md b/docs/src/index-old.md
diff --git a/docs/src/learning/intro.md → docs/src/learning/00_intro.md b/docs/src/learning/intro.md → docs/src/learning/00_intro.md
diff --git a/docs/src/learning/compositional_networks.md → ...src/learning/10_compositional_networks.md b/docs/src/learning/compositional_networks.md → ...src/learning/10_compositional_networks.md
diff --git a/docs/src/learning/layers.md → docs/src/learning/11_layers.md b/docs/src/learning/layers.md → docs/src/learning/11_layers.md
diff --git a/docs/src/learning/transformation.md → docs/src/learning/12_transformation.md b/docs/src/learning/transformation.md → docs/src/learning/12_transformation.md
diff --git a/docs/src/learning/arithmetic.md → docs/src/learning/13_arithmetic.md b/docs/src/learning/arithmetic.md → docs/src/learning/13_arithmetic.md
diff --git a/docs/src/learning/aggregation.md → docs/src/learning/14_aggregation.md b/docs/src/learning/aggregation.md → docs/src/learning/14_aggregation.md
diff --git a/docs/src/learning/comparison.md → docs/src/learning/15_comparison.md b/docs/src/learning/comparison.md → docs/src/learning/15_comparison.md
diff --git a/docs/src/learning/qubo_constraints.md → docs/src/learning/20_qubo_constraints.md b/docs/src/learning/qubo_constraints.md → docs/src/learning/20_qubo_constraints.md
diff --git a/docs/src/learning/qubo_encoding.md → docs/src/learning/21_qubo_encoding.md b/docs/src/learning/qubo_encoding.md → docs/src/learning/21_qubo_encoding.md
diff --git a/docs/src/learning/qubo_learning.md → docs/src/learning/22_qubo_learning.md b/docs/src/learning/qubo_learning.md → docs/src/learning/22_qubo_learning.md
diff --git a/docs/src/learning/30_constraints_translator.md b/docs/src/learning/30_constraints_translator.md
@@ -0,0 +1,7 @@
+# ConstraintsTranslator.jl
+
+Documentation for `ConstraintsTranslator.jl`.
+
+<!-- ```@autodocs
+Modules=[ConstraintsTranslator]
+``` -->
diff --git a/docs/src/learning/constraint_learning.md → docs/src/learning/90_constraint_learning.md b/docs/src/learning/constraint_learning.md → docs/src/learning/90_constraint_learning.md
diff --git a/docs/src/meta/meta_strategist.md → docs/src/meta/00_meta_strategist.md b/docs/src/meta/meta_strategist.md → docs/src/meta/00_meta_strategist.md
diff --git a/docs/src/perf/perf_checker.md → docs/src/perf/00_perf_checker.md b/docs/src/perf/perf_checker.md → docs/src/perf/00_perf_checker.md
diff --git a/docs/src/perf/tutorial.md → docs/src/perf/10_tutorial.md b/docs/src/perf/tutorial.md → docs/src/perf/10_tutorial.md
diff --git a/docs/src/perf/perf_interface.md → docs/src/perf/20_perf_interface.md b/docs/src/perf/perf_interface.md → docs/src/perf/20_perf_interface.md
diff --git a/docs/src/perf/benchmark_ext.md → docs/src/perf/30_benchmark_ext.md b/docs/src/perf/benchmark_ext.md → docs/src/perf/30_benchmark_ext.md
diff --git a/docs/src/perf/chairmarks_ext.md → docs/src/perf/40_chairmarks_ext.md b/docs/src/perf/chairmarks_ext.md → docs/src/perf/40_chairmarks_ext.md
diff --git a/docs/src/perf/api.md → docs/src/perf/90_api.md b/docs/src/perf/api.md → docs/src/perf/90_api.md
diff --git a/docs/src/solvers/intro.md → docs/src/solvers/00_intro.md b/docs/src/solvers/intro.md → docs/src/solvers/00_intro.md
diff --git a/docs/src/solvers/cbls.md → docs/src/solvers/10_cbls.md b/docs/src/solvers/cbls.md → docs/src/solvers/10_cbls.md
diff --git a/docs/src/solvers/local_search_solvers.md → docs/src/solvers/60_local_search_solvers.md b/docs/src/solvers/local_search_solvers.md → docs/src/solvers/60_local_search_solvers.md