[md] Make links relative to project root (#5298)

Author: gchatelet

ortools/constraint_solver/README.md

@@ -10,20 +10,20 @@ a technology issued from AI and used in operations research.
 
 To begin, skim:
 
-*   [constraint_solver.h](../constraint_solver/constraint_solver.h):
+*   [constraint_solver.h](/ortools/constraint_solver/constraint_solver.h):
     Declaration of the core objects for the constraint solver.
 
 ### Parameters
 
-* [solver_parameters.proto](../constraint_solver/solver_parameters.proto):
+* [solver_parameters.proto](/ortools/constraint_solver/solver_parameters.proto):
 This file contains protocol buffers for all parameters of the CP solver.
-* [search_limit.proto](../constraint_solver/search_limit.proto):
+* [search_limit.proto](/ortools/constraint_solver/search_limit.proto):
 Holds parameters to limit the search space within the CP solver, which is
 important for performance.
 
 ### Solution
 
-*   [assignment.proto](../constraint_solver/assignment.proto):
+*   [assignment.proto](/ortools/constraint_solver/assignment.proto):
     Holds the solution of a CP problem.
 
 ## Routing solver

ortools/flatzinc/predicates.md

@@ -20,9 +20,9 @@ It contains in particular:
 * [`status.h`][status_h]: Return type for various solver functions.
 
 <!-- Links used throughout the document. -->
-[parameters_proto]: ../glop/parameters.proto
-[benchmark_proto]: ../glop/benchmark.proto
-[lp_solver_h]: ../glop/lp_solver.h
-[preprocessor_h]: ../glop/preprocessor.h
-[revised_simplex_h]: ../glop/revised_simplex.h
-[status_h]: ../glop/status.h
+[parameters_proto]: /ortools/glop/parameters.proto
+[benchmark_proto]: /ortools/glop/benchmark.proto
+[lp_solver_h]: /ortools/glop/lp_solver.h
+[preprocessor_h]: /ortools/glop/preprocessor.h
+[revised_simplex_h]: /ortools/glop/revised_simplex.h
+[status_h]: /ortools/glop/status.h

ortools/glop/README.md

@@ -201,19 +201,19 @@ node.
 You can find some canonical examples in [`samples`][samples].
 
 <!-- Links used throughout the document. -->
-[graph_h]: ../graph_base/graph.h
-[bounded_dijkstra_h]: ../graph/bounded_dijkstra.h
-[bidirectional_dijkstra_h]: ../graph/bidirectional_dijkstra.h
-[shortest_paths_h]: ../graph/shortest_paths.h
-[dag_shortest_path_h]: ../graph/dag_shortest_path.h
-[dag_constrained_shortest_path_h]: ../graph/dag_constrained_shortest_path.h
-[hamiltonian_path_h]: ../graph/hamiltonian_path.h
-[eulerian_path_h]: ../graph/eulerian_path.h
-[connected_components_h]: ../graph/connected_components.h
-[strongly_connected_components_h]: ../graph/strongly_connected_components.h
-[cliques_h]: ../graph/cliques.h
-[linear_assignment_h]: ../graph/linear_assignment.h
-[max_flow_h]: ../graph/max_flow.h
-[min_cost_flow_h]: ../graph/min_cost_flow.h
+[graph_h]: /ortools/graph_base/graph.h
+[bounded_dijkstra_h]: /ortools/graph/bounded_dijkstra.h
+[bidirectional_dijkstra_h]: /ortools/graph/bidirectional_dijkstra.h
+[shortest_paths_h]: /ortools/graph/shortest_paths.h
+[dag_shortest_path_h]: /ortools/graph/dag_shortest_path.h
+[dag_constrained_shortest_path_h]: /ortools/graph/dag_constrained_shortest_path.h
+[hamiltonian_path_h]: /ortools/graph/hamiltonian_path.h
+[eulerian_path_h]: /ortools/graph/eulerian_path.h
+[connected_components_h]: /ortools/graph/connected_components.h
+[strongly_connected_components_h]: /ortools/graph/strongly_connected_components.h
+[cliques_h]: /ortools/graph/cliques.h
+[linear_assignment_h]: /ortools/graph/linear_assignment.h
+[max_flow_h]: /ortools/graph/max_flow.h
+[min_cost_flow_h]: /ortools/graph/min_cost_flow.h
 [samples]: ../graph/samples/
-[graph]: ../graph_base/
+[graph]: /ortools/graph_base/

ortools/graph/README.md

@@ -6,7 +6,7 @@ within Google3: they are intended for use by the open-source community only.
 Note: the wrapper is being written and highly experimental.
 
 For now, only MathOpt is accessible through
-[its C API](../math_opt/core/c_api).
+[its C API](/ortools/math_opt/core/c_api/).
 
 TODO(user): how to run this on my machine?
 
@@ -19,10 +19,10 @@ The Julia wrapper is divided into three Julia packages:
 
 *   [`ORTools_jll`](https://github.com/JuliaRegistries/General/tree/master/jll/O/ORTools_jll)
     contains the precompiled OR-Tools binaries.
-*   [`ORToolsGenerated.jl`](../ORToolsGenerated.jl)
+*   [`ORToolsGenerated.jl`](/ortools/julia/ORToolsGenerated.jl)
     contains the generated part of the wrapper. For now, this package
     corresponds to Protocol Buffers files.
-*   [`ORTools.jl`](../ORTools.jl)
+*   [`ORTools.jl`](/ortools/julia/ORTools.jl)
     is the actual, high-level wrapper (more specifically, the
     [MathOptInterface](https://github.com/jump-dev/MathOptInterface.jl) code for
     use through [JuMP](https://jump.dev/)).
@@ -44,13 +44,13 @@ When releasing a new version of OR-Tools:
     Buffers files any time the new release has new Protocol Buffers files.
 
 2.  Update the generated files in
-    [`ORToolsGenerated.jl`](../ORToolsGenerated.jl).
+    [`ORToolsGenerated.jl`](/ortools/julia/ORToolsGenerated.jl).
     This step depends on the first one: the PR you wrote at the first step must
     be accepted and merged into the repository. Updating the generated files
     amounts to have a local Julia installation, adding the new version of
     `ORTools_jll` (within a Julia shell, `]add ORTools_jll` the first time, then
     update the version with `]update`), and calling the script
-    [`update_package.jl`](../ORToolsGenerated.jl/scripts/update_package.jl).
+    [`update_package.jl`](/ortools/julia/ORToolsGenerated.jl/scripts/update_package.jl).
 
 3.  Synchronize the results of the previous step with OR-Tools' repository: the
     updated files go into `ortools/julia/ORToolsGenerated/` (an updated
@@ -129,10 +129,10 @@ If there is an update in the C API, use `scripts/TODO(user)` to update the
 generated code to call the C functions.
 
 If there is an update in the MathOpt proto interface, use
-[`ORToolsGenerated.jl/scripts/gen_pb.jl`](../ORToolsGenerated.jl/scripts/gen_pb.jl)
+[`ORToolsGenerated.jl/scripts/gen_pb.jl`](/ortools/julia/ORToolsGenerated.jl/scripts/gen_pb.jl)
 to update the generated Protocol Buffers code. This script is automatically
 called by
-[`update_package.jl`](../ORToolsGenerated.jl/scripts/update_package.jl).
+[`update_package.jl`](/ortools/julia/ORToolsGenerated.jl/scripts/update_package.jl).
 
 ## Design decisions
 

ortools/julia/docs/index.md

@@ -29,39 +29,39 @@ This module provides:
 
 To begin, skim
 
-*   [linear_solver.proto](../linear_solver/linear_solver.proto):
+*   [linear_solver.proto](/ortools/linear_solver/linear_solver.proto):
     Specifically, look at `MPModelProto`. This gives a succinct description of
     what problems can be solved.
 
-*   [solve_mp_model.h](../linear_solver/solve_mp_model.h):
+*   [solve_mp_model.h](/ortools/linear_solver/solve_mp_model.h):
     This file contains the key functions to run various solvers.
 
 ## Available solvers
 
 Each *\*_interface.cc*  file corresponds to one of the solver accessible
 through the wrapper.
 
-* Google's BOP (boolean) solver: [bop_interface.cc](../linear_solver/bop_interface.cc)
+* Google's BOP (boolean) solver: [bop_interface.cc](/ortools/linear_solver/bop_interface.cc)
 
-* Google's GLOP (lp) solver: [glop_interface.cc](../linear_solver/glop_interface.cc)
+* Google's GLOP (lp) solver: [glop_interface.cc](/ortools/linear_solver/glop_interface.cc)
 
-* Gurobi (MIP) solver: [gurobi_interface.cc](../linear_solver/gurobi_interface.cc)
+* Gurobi (MIP) solver: [gurobi_interface.cc](/ortools/linear_solver/gurobi_interface.cc)
 
-* Google's PLDP solver: [pdlp_interface.cc](../linear_solver/pdlp_interface.cc)
+* Google's PLDP solver: [pdlp_interface.cc](/ortools/linear_solver/pdlp_interface.cc)
 
-* SCIP (MIP) solver: [scip_interface.cc](../linear_solver/scip_interface.cc)
+* SCIP (MIP) solver: [scip_interface.cc](/ortools/linear_solver/scip_interface.cc)
 
-* Google's CP-SAT solver: [sat_interface.cc](../linear_solver/sat_interface.cc)
+* Google's CP-SAT solver: [sat_interface.cc](/ortools/linear_solver/sat_interface.cc)
 
-* Coin-OR Cbc (MIP) solver: [cbc_interface.cc](../linear_solver/cbc_interface.cc)
+* Coin-OR Cbc (MIP) solver: [cbc_interface.cc](/ortools/linear_solver/cbc_interface.cc)
 
-* Coin-OR Clp (LP) solver: [clp_interface.cc](../linear_solver/clp_interface.cc)
+* Coin-OR Clp (LP) solver: [clp_interface.cc](/ortools/linear_solver/clp_interface.cc)
 
-* CPLEX (MIP) solver: [cplex_interface.cc](../linear_solver/cplex_interface.cc)
+* CPLEX (MIP) solver: [cplex_interface.cc](/ortools/linear_solver/cplex_interface.cc)
 
-* GLPK (MIP) solver: [glpk_interface.cc](../linear_solver/glpk_interface.cc)
+* GLPK (MIP) solver: [glpk_interface.cc](/ortools/linear_solver/glpk_interface.cc)
 
-* Xpress (MIP) solver: [xpress_interface.cc](../linear_solver/xpress_interface.cc)
+* Xpress (MIP) solver: [xpress_interface.cc](/ortools/linear_solver/xpress_interface.cc)
 
 ## Wrappers
 
@@ -76,4 +76,4 @@ through the wrapper.
 
 ## Samples
 
-You can find some canonical examples in [samples](../linear_solver/samples/)
+You can find some canonical examples in [samples](/ortools/linear_solver/samples/)

ortools/linear_solver/README.md

@@ -68,19 +68,19 @@ This group of libraries handles reading and writing LP data in various formats.
 
 <!-- Links used throughout the document. -->
 
-[lp_types_h]: ../lp_data/lp_types.h
-[lp_data_h]: ../lp_data/lp_data.h
-[lp_utils_h]: ../lp_data/lp_utils.h
-[sparse_h]: ../lp_data/sparse.h
-[sparse_vector_h]: ../lp_data/sparse_vector.h
-[sparse_column_h]: ../lp_data/sparse_column.h
-[sparse_row_h]: ../lp_data/sparse_row.h
-[scattered_vector_h]: ../lp_data/scattered_vector.h
-[matrix_scaler_h]: ../lp_data/matrix_scaler.h
-[lp_decomposer_h]: ../lp_data/lp_decomposer.h
-[permutation_h]: ../lp_data/permutation.h
-[lp_parser_h]: ../lp_data/lp_parser.h
-[mps_reader_h]: ../lp_data/mps_reader.h
-[sol_reader_h]: ../lp_data/sol_reader.h
-[proto_utils_h]: ../lp_data/proto_utils.h
-[lp_print_utils_h]: ../lp_data/lp_print_utils.h
+[lp_types_h]: /ortools/lp_data/lp_types.h
+[lp_data_h]: /ortools/lp_data/lp_data.h
+[lp_utils_h]: /ortools/lp_data/lp_utils.h
+[sparse_h]: /ortools/lp_data/sparse.h
+[sparse_vector_h]: /ortools/lp_data/sparse_vector.h
+[sparse_column_h]: /ortools/lp_data/sparse_column.h
+[sparse_row_h]: /ortools/lp_data/sparse_row.h
+[scattered_vector_h]: /ortools/lp_data/scattered_vector.h
+[matrix_scaler_h]: /ortools/lp_data/matrix_scaler.h
+[lp_decomposer_h]: /ortools/lp_data/lp_decomposer.h
+[permutation_h]: /ortools/lp_data/permutation.h
+[lp_parser_h]: /ortools/lp_data/lp_parser.h
+[mps_reader_h]: /ortools/lp_data/mps_reader.h
+[sol_reader_h]: /ortools/lp_data/sol_reader.h
+[proto_utils_h]: /ortools/lp_data/proto_utils.h
+[lp_print_utils_h]: /ortools/lp_data/lp_print_utils.h

ortools/lp_data/README.md

@@ -6,13 +6,13 @@ as GLOP, CP-SAT, SCIP and Gurobi. In particular, a single API is provided to
 make these solvers largely interoperable.
 
 New code should prefer MathOpt to `MPSolver`, as defined in
-[linear_solver.h](../linear_solver/linear_solver.h)
+[linear_solver.h](/ortools/linear_solver/linear_solver.h)
 when possible.
 
 MathOpt has client libraries in C++, Python, and Java that most users should use
 to build and solve their models. A proto API is also provided, but this is not
 recommended for most users.
 
 See
-[parameters.proto](../math_opt/parameters.proto?q=SolverTypeProto)
+[parameters.proto](/ortools/math_opt/parameters.proto?q=SolverTypeProto)
 for the list of supported solvers.

ortools/math_opt/README.md

@@ -43,13 +43,13 @@ performance and numerical stability. See also
 
 <!-- Links used throughout the document. -->
 [background]: https://developers.google.com/optimization/lp/pdlp_math
-[primal_dual_hybrid_gradient_h]: ../pdlp/primal_dual_hybrid_gradient.h
-[quadratic_program_h]: ../pdlp/quadratic_program.h
-[quadratic_program_io_h]: ../pdlp/quadratic_program_io.h
-[sharded_quadratic_program_h]: ../pdlp/sharded_quadratic_program.h
-[sharder_h]: ../pdlp/sharder.h
-[scheduler_h]: ../pdlp/scheduler.h
-[iteration_stats_h]: ../pdlp/iteration_stats.h
-[termination_h]: ../pdlp/termination.h
-[solvers_proto]: ../pdlp/solvers.proto
-[solve_log_proto]: ../pdlp/solve_log.proto
+[primal_dual_hybrid_gradient_h]: /ortools/pdlp/primal_dual_hybrid_gradient.h
+[quadratic_program_h]: /ortools/pdlp/quadratic_program.h
+[quadratic_program_io_h]: /ortools/pdlp/quadratic_program_io.h
+[sharded_quadratic_program_h]: /ortools/pdlp/sharded_quadratic_program.h
+[sharder_h]: /ortools/pdlp/sharder.h
+[scheduler_h]: /ortools/pdlp/scheduler.h
+[iteration_stats_h]: /ortools/pdlp/iteration_stats.h
+[termination_h]: /ortools/pdlp/termination.h
+[solvers_proto]: /ortools/pdlp/solvers.proto
+[solve_log_proto]: /ortools/pdlp/solve_log.proto

ortools/pdlp/README.md

@@ -7,24 +7,24 @@ extension that is implemented on top of the CP solver library.
 
 To begin, skim:
 
-*   [routing.h](../routing/routing.h): The
+*   [routing.h](/ortools/routing/routing.h): The
     vehicle routing library lets one model and solve generic vehicle routing
     problems ranging from the Traveling Salesman Problem to more complex
     problems such as the Capacitated Vehicle Routing Problem with Time Windows.
 
 ### Parameters
 
-*   [parameters.proto](../routing/parameters.proto):
+*   [parameters.proto](/ortools/routing/parameters.proto):
     The Vehicle Routing solver parameters.
-*   [enums.proto](../routing/enums.proto):
+*   [enums.proto](/ortools/routing/enums.proto):
     Enums used to define routing parameters.
 
 ### Solution
 
-*   [assignment.proto](../constraint_solver/assignment.proto):
+*   [assignment.proto](/ortools/constraint_solver/assignment.proto):
     Holds the solution of a Routing problem (as a special case of a CS problem).
 
 ## Parsers
 
 Utilities for file formats are in the
-[`parsers`](../routing/parsers) subfolder.
+[`parsers`](/ortools/routing/parsers) subfolder.