2022-12-10 11:52:12 +00:00
|
|
|
#!/bin/bash
|
|
|
|
|
|
|
|
|
|
# The website is built using MkDocs with the Material theme.
|
|
|
|
|
# https://squidfunk.github.io/mkdocs-material/
|
|
|
|
|
# It requires Python to run.
|
|
|
|
|
# Install the packages with the following command:
|
|
|
|
|
# pip install mkdocs mkdocs-material mkdocs-redirects
|
|
|
|
|
|
|
|
|
|
set -ex
|
|
|
|
|
|
2023-05-27 19:06:15 +01:00
|
|
|
# Test generating the javadoc jars
|
2026-01-25 12:37:13 +00:00
|
|
|
./gradlew publishToMavenLocal -DRELEASE_SIGNING_ENABLED=false -PokhttpDokka=true
|
2023-05-27 19:06:15 +01:00
|
|
|
|
2022-12-10 11:52:12 +00:00
|
|
|
# Generate the API docs
|
2026-01-25 12:37:13 +00:00
|
|
|
./gradlew dokkaGeneratePublicationHtml -PokhttpDokka=true
|
2022-12-10 11:52:12 +00:00
|
|
|
|
2026-03-15 05:01:42 -04:00
|
|
|
mv ./build/dokka/html docs/5.x
|
2022-12-10 11:52:12 +00:00
|
|
|
|
|
|
|
|
# Copy in special files that GitHub wants in the project root.
|
|
|
|
|
cat README.md | grep -v 'project website' > docs/index.md
|
|
|
|
|
cp CHANGELOG.md docs/changelogs/changelog.md
|
|
|
|
|
cp CONTRIBUTING.md docs/contribute/contributing.md
|
|
|
|
|
|
|
|
|
|
# Build the site locally
|
|
|
|
|
mkdocs build
|