1
0
mirror of https://github.com/square/okhttp.git synced 2025-04-19 07:42:15 +03:00
okhttp/test_docs.sh

26 lines
718 B
Bash
Executable File

#!/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
# Test generating the javadoc jars
./gradlew publishToMavenLocal -DRELEASE_SIGNING_ENABLED=false
# Generate the API docs
./gradlew dokkaHtmlMultiModule
mv ./build/dokka/htmlMultiModule docs/4.x
# 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