update doc, fix references

hlefebvr · Jun 21, 2024 · ab67c24 · ab67c24
1 parent 8f2a0d1
commit ab67c24
Show file tree

Hide file tree

Showing 23 changed files with 31 additions and 21 deletions.
diff --git a/docs/api/classes/branch-and-bound/BranchAndBound.rst b/docs/api/classes/branch-and-bound/BranchAndBound.rst
@@ -8,7 +8,7 @@ It can be used to create customized branch-and-bound algorithms with a large deg
 
 .. seealso::
 
-    If you are not familiar with optimizers and optimizer factories, please refer to :ref:`this page <api_optimizers>`.
+    If you are not familiar with optimizers and optimizer factories, please refer to :ref:`this page <mip_optimizers>`.
 
 .. admonition:: Example
 

diff --git a/docs/api/classes/branch-and-bound/BranchAndBoundCallback.rst b/docs/api/classes/branch-and-bound/BranchAndBoundCallback.rst
@@ -1,3 +1,5 @@
+.. _api_BranchAndBoundCallback:
+
 BranchAndBoundCallback
 ======================
 

diff --git a/docs/api/classes/column-generation/DantzigWolfeDecomposition.rst b/docs/api/classes/column-generation/DantzigWolfeDecomposition.rst
@@ -4,6 +4,6 @@ DantzigWolfeDecomposition
 .. hint::
 
     This page documents on the `DantzigWolfeDecomposition` optimizer factory. Note that there are also
-    :ref:`Dantzig-Wolfe Decomposition tutorials <tutorials_dantzig_wolfe>`.
+    :ref:`Dantzig-Wolfe Decomposition tutorials <tutorial_DantzigWolfe>`.
 
 .. doxygenclass:: idol::DantzigWolfeDecomposition
diff --git a/docs/api/classes/universal-callbacks/Callback.rst b/docs/api/classes/universal-callbacks/Callback.rst
@@ -1,3 +1,5 @@
+.. _api_Callback:
+
 Callback
 ========
 

diff --git a/docs/api/classes/universal-callbacks/LazyCutCallback.rst b/docs/api/classes/universal-callbacks/LazyCutCallback.rst
@@ -54,7 +54,7 @@ with :math:`\varepsilon` a given tolerance (by default, :code:`Tolerance::Feasib
 .. hint::
 
     You may also be interested by a tutorial showing how you can implement a simple Benders Decomposition using lazy
-    cuts. :ref:`See Benders Decomposition tutorial <decomposition_benders>`.
+    cuts. :ref:`See Benders Decomposition tutorial <tutorial_user_lazy_cuts>`.
 
 
 .. doxygenclass:: idol::LazyCutCallback
diff --git a/docs/api/constants/tolerances.rst b/docs/api/constants/tolerances.rst
@@ -1,4 +1,4 @@
-.. _api_api_tolerances:
+.. _api_tolerances:
 
 Tolerances and Numerics
 =======================

diff --git a/docs/api/types/common/CtrType → docs/api/types/common/CtrType.rst b/docs/api/types/common/CtrType → docs/api/types/common/CtrType.rst
diff --git a/docs/api/types/universal-callbacks/CallbackEvent.rst b/docs/api/types/universal-callbacks/CallbackEvent.rst
@@ -1,3 +1,5 @@
+.. _api_CallbackEvent:
+
 Events
 ======
 

diff --git a/docs/developer_guide/build-the-doc.rst b/docs/developer_guide/build-the-doc.rst
@@ -9,7 +9,7 @@ This page explains how to build the documentation on a local machine.
 Dependencies
 ------------
 
-LowerLevelDescription
+Description
 ^^^^^^^^^^^
 
 The documentation is built using `doxygen`_ and a bunch of other tools, in particular:

diff --git a/docs/examples/bilevel-problem.rst b/docs/examples/bilevel-problem.rst
@@ -1,7 +1,7 @@
 .. _example_mibs:
 
-MILP-MILP Example with MibS
-===========================
+Bilevel MILP-MILP (MibS)
+========================
 
 Problem Definition
 ------------------

diff --git a/docs/examples/facility-location-problem.rst b/docs/examples/facility-location-problem.rst
@@ -1,7 +1,7 @@
 .. _example_flp:
 
-Facility Location Problem
-=========================
+Facility Location Problem (Branch-and-Bound)
+============================================
 
 Problem Definition
 ------------------

diff --git a/docs/examples/generalized-assignment-problem.rst b/docs/examples/generalized-assignment-problem.rst
@@ -1,5 +1,5 @@
-Generalized Assignment Problem
-==============================
+Generalized Assignment Problem (Branch-and-Price)
+=================================================
 
 Problem Definition
 ------------------

diff --git a/docs/examples/knapsack-problem.rst b/docs/examples/knapsack-problem.rst
@@ -1,5 +1,5 @@
-Knapsack Problem
-================
+Knapsack Problem (HiGHS)
+=========================
 
 Problem Definition
 ------------------

diff --git a/docs/faq/mosek-and-eigen.rst b/docs/faq/mosek-and-eigen.rst
@@ -1,3 +1,5 @@
+.. _mosek_and_socp:
+
 Why is Eigen necessary to solve QPs and QCQPs with Mosek?
 =========================================================
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -38,7 +38,7 @@ combined to create a new algorithm, `branch_and_price`, which can be instantiate
 Getting Started With Idol
 -------------------------
 
-If you are new to idol, be sure to have a look at our :ref:`tutorials <tutorials_basics>`. If you want to get a fast hands-on
+If you are new to idol, be sure to have a look at our :ref:`tutorials <tutorials>`. If you want to get a fast hands-on
 start, have a look at our :ref:`local installation guideline <installation_local>`. It is the easiest installation process
 one could think of since it automatically downloads the latest version of idol, and installs it locally in a sub-folder.
 It's really a mater of seconds before you can start using idol.

diff --git a/docs/tutorials/mixed-integer-programming/dantzig-wolfe/index.rst b/docs/tutorials/mixed-integer-programming/dantzig-wolfe/index.rst
@@ -1,3 +1,5 @@
+.. _tutorial_DantzigWolfe:
+
 Column Generation and Branch-and-Price Algorithm
 ================================================
 

diff --git a/docs/tutorials/mixed-integer-programming/dantzig-wolfe/old/dantzig_wolfe.rst b/docs/tutorials/mixed-integer-programming/dantzig-wolfe/old/dantzig_wolfe.rst
@@ -90,7 +90,7 @@ Assuming that the instance file is named :code:`instance.txt`, it can be loaded
     const unsigned int n_agents = instance.n_agents();
     const unsigned int n_jobs = instance.n_jobs();
 
-We are now ready to model our problem (for more details, refer to :ref:`this tutorial on modeling <modeling_optimization_problems>`)
+We are now ready to model our problem (for more details, refer to :ref:`this tutorial on modeling <mip_modeling>`)
 
 .. code-block:: cpp
 

diff --git a/docs/tutorials/mixed-integer-programming/dantzig-wolfe/strong-branching.rst b/docs/tutorials/mixed-integer-programming/dantzig-wolfe/strong-branching.rst
@@ -21,7 +21,7 @@ part is closest to `0.5`. Unfortunately, this rule performs badly in practice. M
 computationally hard, it makes sense to spend some time in carefully choosing the variable to branch on. This is typically
 the case when nodes are solved using Column Generation.
 
-.. info::
+.. hint::
 
     Clearly, Strong Branching is not only used in the context of column generation. It is a general technique that can be
     used in any context where solving a node is computationally expensive. Thus, this tutorial is not specific to the

diff --git a/docs/tutorials/mixed-integer-programming/modeling/variables.rst b/docs/tutorials/mixed-integer-programming/modeling/variables.rst
@@ -72,7 +72,7 @@ parameters. For instance, the following code is equivalent to the previous one.
     Model model2(env);
     model2.add(x, TempVar(0, 10, Continuous));
 
-Here, we used the class :ref:`TempVar <api_TempVar>` to create a temporary variable. A temporary variable is a variable
+Here, we used the class :ref:`TempVar <api_mip_variables_TempVar>` to create a temporary variable. A temporary variable is a variable
 which has not been instantiate yet. It is only a "template" of a variable specifying its bounds and type. Here, we therefore
 add the variable :math:`x` to the second model and directly set its attributes (bounds and type) accordingly.
 

diff --git a/docs/tutorials/mixed-integer-programming/optimizers/create-universal-callback.rst b/docs/tutorials/mixed-integer-programming/optimizers/create-universal-callback.rst
@@ -66,7 +66,7 @@ The nested class :code:`Strategy` is the actual callback implementation. It is a
 overrides the :code:`operator()` method. In this example, the callback prints the value of the primal solution whenever the event
 triggering the callback is :code:`IncumbentSolution`. In other words, this callback will print out all incumbent solutions found by the solver.
 
-As for the :ref:`UserCutCallback <api_UserCutCallback>` and :ref:`LazyConstraintCallback <api_LazyConstraintCallback>` classes,
+As for the :ref:`UserCutCallback <api_UserCutCallback>` and :ref:`LazyConstraintCallback <api_LazyCutCallback>` classes,
 our new callback can be added to an optimizer as follows.
 
 .. code:: cpp

diff --git a/docs/tutorials/mixed-integer-programming/optimizers/universal-callbacks.rst b/docs/tutorials/mixed-integer-programming/optimizers/universal-callbacks.rst
@@ -252,7 +252,7 @@ We are now ready to create the callback factory and pass it to the optimizer. Th
 
 That's it! The optimizer will now call the callback function at each node of the branch-and-cut tree, and add the cuts to the master problem whenever a violated constraint is found.
 
-.. info::
+.. hint::
 
     Here, we added a call to :code:`Gurobi::with_lazy_cut`. This is because the Gurobi optimizer does not support lazy cuts by default
     and one needs to explicitly enable them.

diff --git a/lib/include/idol/modeling/constraints/TempCtr.h b/lib/include/idol/modeling/constraints/TempCtr.h
@@ -24,7 +24,7 @@ namespace idol {
  *
  * This class represents a constraint which has not been built yet by a Model.
  * It contains all the arguments needed to create a real constraint
- * as instantiated by the `Ctr` class. It is made of a row (see `Row`) and a type (see `CtrType.rst`).
+ * as instantiated by the `Ctr` class. It is made of a row (see `Row`) and a type (see `CtrType.rst.rst`).
  *
  * Typically, one creates a `TempCtr` by using the overloaded operators `<=`, `>=` and `==` between variable expressions (i.e., `Expr`) and
  * constant terms (i.e., `Constant`).

diff --git a/lib/include/idol/modeling/models/Model.h b/lib/include/idol/modeling/models/Model.h
@@ -837,7 +837,7 @@ class idol::Model : public Matrix {
      *
      * Example:
      * ```cpp
-     * CtrType.rst type = model.get_ctr_type(c1);
+     * CtrType.rst.rst type = model.get_ctr_type(c1);
      *
      * if (type == LessOrEqual) {
      *      std::cout << "c1 is a <= constraint" << std::endl;