cmake: improve python pdoc title page

2023-02-02 11:35:56 +01:00
parent 5273b3e7de
commit ecf41fd428
2 changed files with 32 additions and 1 deletions
--- a/ortools/python/init.py.in
+++ b/ortools/python/init.py.in
@@ -0,0 +1,24 @@
+r'''
+# OR-Tools
+
+This is the reference documentation for Google OR-Tools.
+
+This repository contains several component:
+
+ - `ortools.init`,
+
+ - `ortools.algorithms`,
+ - `ortools.graph`,
+
+ - `ortools.linear_solver`,
+ - `ortools.bop`,
+ - `ortools.glop`,
+ - `ortools.pdlp`,
+ - `ortools.constraint_solver`,
+ - `ortools.sat`,
+ - `ortools.packing`,
+ - `ortools.scheduling`,
+'''
+
+__docformat__ = "markdown"  # explicitly disable rST processing above.
+__version__ = "@PROJECT_VERSION@"