Skip to content

Latest commit

 

History

History

scripts

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
README.md
README.md
 
 
archive_docs.py
archive_docs.py
 
 
check_for_missing_docs.py
check_for_missing_docs.py
 
 
docker-build.sh
docker-build.sh
 
 
docker-serve-latest.sh
docker-serve-latest.sh
 
 
docker-serve.sh
docker-serve.sh
 
 
docker-stop.sh
docker-stop.sh
 
 
docker-vars.sh
docker-vars.sh
 
 
docs_link_fixer.py
docs_link_fixer.py
 
 
find_misaligned_titles.py
find_misaligned_titles.py
 
 
generate-search-index.sh
generate-search-index.sh
 
 
generate_all_docs.sh
generate_all_docs.sh
 
 
generate_c_api_docs.py
generate_c_api_docs.py
 
 
generate_config_docs.py
generate_config_docs.py
 
 
generate_function_json.py
generate_function_json.py
 
 
generate_nodejs_docs.js
generate_nodejs_docs.js
 
 
generate_python_docs.py
generate_python_docs.py
 
 
generate_search.py
generate_search.py
 
 
get_calendar.py
get_calendar.py
 
 
install-dependencies.sh
install-dependencies.sh
 
 
lint.sh
lint.sh
 
 
list_community_extensions.sh
list_community_extensions.sh
 
 
offline_docs_replace.py
offline_docs_replace.py
 
 
redirect.py
redirect.py
 
 
rename_page.py
rename_page.py
 
 
serve-latest.sh
serve-latest.sh
 
 
serve.sh
serve.sh
 
 
sql_to_wasm_shell_link.py
sql_to_wasm_shell_link.py
 
 
stackoverflow_bot.py
stackoverflow_bot.py
 
 
use-link-tags.py
use-link-tags.py
 
 

README.md

DuckDB-Web scripts

generate_all_docs.sh

Prerequisites

Install the NodeJS and Python dependencies in the duckdb-web directory:

npm install
pip install -r requirements.txt

Using DuckDB Nightly Build

Download the Nightly DuckDB distribution, extract the duckdb file and move it to the directory expected by the scripts:

mkdir -p build/release
mv duckdb build/release

Run the script as follows:

./scripts/generate_all_docs.sh <path_to_duckdb_directory>

Using DuckDB main

Build DuckDB and install the in-tree extensions.

Go to the DuckDB directory and run:

GEN=ninja EXTENSION_CONFIGS=".github/config/in_tree_extensions.cmake" make
cd build/release/extension/
for EXTENSION in *; do
    ../duckdb -c "INSTALL '${EXTENSION}/${EXTENSION}.duckdb_extension';"
done

Run the script as follows:

./scripts/generate_all_docs.sh <path_to_duckdb_source_directory>

For a detailed guide on how to disable/enable extensions during build, see Building and Installing Extensions from Source.