Skip to content

Commit

Permalink
change landing page for pdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
lperron committed Jul 3, 2023
1 parent 346642b commit 417cbb8
Showing 1 changed file with 31 additions and 10 deletions.
41 changes: 31 additions & 10 deletions ortools/python/__init__.py.in
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 417cbb8

Please sign in to comment.