Merge pull request #1223 from szarnyasg/fence-generated-blocks

Add warning in front of generated code blocks

scripts/README.md

@@ -0,0 +1,22 @@
+# DuckDB-Web scripts
+
+## `generate_all_docs.sh`
+
+### Prerequisites
+
+Get the DuckDB nightly build from the [installation page](https://duckdb.org/docs/installation/), available under the GitHub main (Bleeding Edge) tab.
+
+Install the NodeJS and Python dependencies:
+
+```bash
+npm install
+pip install -r requirements.txt
+```
+
+### Running the script
+
+Run the script as follows:
+
+```bash
+./scripts/generate_all_docs.sh <path_to_bleeding_edge_duckdb_dir>
+```

scripts/generate_all_docs.sh

@@ -3,7 +3,7 @@ set -xeuo pipefail
 
 if [ "${1-}" = "" ]
 then
-    echo >&2 "usage: $0 duckdb_dir"
+    echo >&2 "Usage: $0 duckdb_dir_with_debug_duckdb"
     exit 1
 fi
 

scripts/generate_docs.py

@@ -277,7 +277,7 @@ def replace_docs_in_file(file_name, group_name, docs_string_for_this_group):
             text = (
                 text.rsplit(api_ref_split, 1)[0]
                 + api_ref_split
-                + '\n\n'
+                + '\n\n<!-- This section is generated by scripts/generate_config_docs.py -->\n\n'
                 + docs_string_for_this_group
             )
             found = True