From 417cbb8babad239ceb29efca74826a46d04769c8 Mon Sep 17 00:00:00 2001 From: Laurent Perron Date: Mon, 3 Jul 2023 16:59:45 +0200 Subject: [PATCH] change landing page for pdoc --- ortools/python/__init__.py.in | 41 ++++++++++++++++++++++++++--------- 1 file changed, 31 insertions(+), 10 deletions(-) diff --git a/ortools/python/__init__.py.in b/ortools/python/__init__.py.in index 0dc4c3204a..84d0e2f59a 100644 --- a/ortools/python/__init__.py.in +++ b/ortools/python/__init__.py.in @@ -5,19 +5,40 @@ This is the reference documentation for Google OR-Tools. This repository contains several component: - - `ortools.init`, +### Link with the C++ layer + - `ortools.init.python.init`, - - `ortools.algorithms`, - - `ortools.graph`, +### Knapsack solver + - `ortools.algorithms.python.knapsack_solver`, - - `ortools.linear_solver`, - - `ortools.bop`, - - `ortools.glop`, +### Graph and flow algorithms +- `ortools.graph.python.linear_sum_assignment`, +- `ortools.graph.python.max_flow`, +- `ortools.graph.python.min_cost_flow`, + +### Routing library and legacy Constraint Programming Solver + - `ortools.constraint_solver.pywrapcp`, + +### Minimalistic linear solver wrapper +- `ortools.linear_solver.python.model_builder` + +### CP-SAT + - `ortools.sat.python.cp_model`, + - `ortools.util.python.sorted_interval_list`, + - `ortools.sat.cp_model_pb2` + - `ortools.sat.sat_parameters_pb2` + +### Legacy linear solver wrapper + - `ortools.linear_solver.pywraplp`, + - `ortools.linear_solver.linear_solver_py_pb2`, + +### Linear solver backends + - `ortools.bop.bop_parameters_pb2`, + - `ortools.glop.glop_parameters_pb2`, - `ortools.pdlp`, - - `ortools.constraint_solver`, - - `ortools.sat`, - - `ortools.packing`, - - `ortools.scheduling`, + +### PSPLIB Parser + - `ortools.scheduling.python.rcpsp`, ''' __docformat__ = "markdown" # explicitly disable rST processing above.