Improving mdbook

.mdbook/book.toml

@@ -6,3 +6,5 @@ src = "."
 title = "CP-SAT Primer - Using and Understanding OR-Tools' CP-SAT"
 [output.html]
 mathjax-support = true
+edit-url-template = "https://github.com/d-krupke/cpsat-primer/edit/main/{path}"
+git-repository-url = "https://github.com/d-krupke/cpsat-primer/"

README.md

@@ -1,3 +1,5 @@
+<!-- This file was generated by the `build.py` script. Do not edit it manually. -->
+<!-- 00_intro.md -->
 <!-- EDIT THIS PART VIA 00_intro.md -->
 
 # Using and Understanding OR-Tools' CP-SAT: A Primer and Cheat Sheet
@@ -120,6 +122,8 @@ awaits you in this primer:
 
 ---
 
+<!-- This file was generated by the `build.py` script. Do not edit it manually. -->
+<!-- 01_installation.md -->
 <!-- EDIT THIS PART VIA 01_installation.md -->
 
 ## Installation
@@ -186,6 +190,8 @@ which are likely to be similar. Since we frequently use Gurobi in addition to
 CP-SAT, our hardware choices were also influenced by their recommendations.
 
 
+<!-- This file was generated by the `build.py` script. Do not edit it manually. -->
+<!-- 02_example.md -->
 <!-- EDIT THIS PART VIA 02_example.md -->
 
 ## Example
@@ -383,6 +389,8 @@ very good at that).
 
 ---
 
+<!-- This file was generated by the `build.py` script. Do not edit it manually. -->
+<!-- 03_big_picture.md -->
 <!-- EDIT THIS PART VIA 03_big_picture.md -->
 <a name="section-alternatives"></a>
 
@@ -552,6 +560,8 @@ open-source tool.
 
 ---
 
+<!-- This file was generated by the `build.py` script. Do not edit it manually. -->
+<!-- 04_modelling.md -->
 <!--EDIT THIS PART VIA 04_modelling.md -->
 ## Modelling
 <a name="04-modelling"></a>
@@ -1700,6 +1710,8 @@ If you need more, you can check out the
 ---
 
 
+<!-- This file was generated by the `build.py` script. Do not edit it manually. -->
+<!-- 05_parameters.md -->
 <!-- EDIT THIS PART VIA 05_parameters.md -->
 
 ## Parameters
@@ -2217,6 +2229,8 @@ some conflicts.
 
 ---
 
+<!-- This file was generated by the `build.py` script. Do not edit it manually. -->
+<!-- 06_coding_patterns.md -->
 
 <!-- EDIT THIS PART VIA 06_coding_patterns.md -->
 ## Coding Patterns for Optimization Problems
@@ -2885,6 +2899,8 @@ class KnapsackSolver:
 
 ---
 
+<!-- This file was generated by the `build.py` script. Do not edit it manually. -->
+<!-- 07_under_the_hood.md -->
 <!-- EDIT THIS PART VIA 07_under_the_hood.md -->
 
 ## How does it work?
@@ -3069,6 +3085,8 @@ At times, NP-hard problems inherently pose formidable challenges, leaving us
 with no alternative but to seek more manageable modeling approaches instead of
 looking for better solvers.
 
+<!-- This file was generated by the `build.py` script. Do not edit it manually. -->
+<!-- 08_benchmarking.md -->
 <!-- EDIT THIS PART VIA 08_benchmarking.md -->
 
 ## Benchmarking your Model
@@ -3479,6 +3497,8 @@ and nice plots on which we can base our decisions.
 > [Algorithm Selection](https://en.wikipedia.org/wiki/Algorithm_selection)
 > problem and can be surprisingly complex, too.
 
+<!-- This file was generated by the `build.py` script. Do not edit it manually. -->
+<!-- 09_lns.md -->
 <!-- EDIT THIS PART VIA 08_lns.md -->
 
 ## Using CP-SAT for Bigger Problems with Large Neighborhood Search

build.py

@@ -1,3 +1,9 @@
+"""
+This file is used to build the `README.md` file from all markdown files in the current directory.
+It also converts the markdown files to a format that can be used by the `mdbook` tool, which we
+use to generate the website.
+"""
+
 import os
 import re
 from pathlib import Path
@@ -32,8 +38,11 @@ def convert_for_mdbook(content):
     # concat them and write them to `README.md`
     with open("README.md", "w") as f:
         for file in markdown_files:
+            disclaimer = "<!-- This file was generated by the `build.py` script. Do not edit it manually. -->\n"
             with open(file, "r") as current_file:
                 content = current_file.read()
+                f.write(disclaimer)
+                f.write("<!-- " + file + " -->\n")
                 f.write(content)
                 f.write("\n\n")
                 Path("./.mdbook/").mkdir(parents=True, exist_ok=True)