mirror of
https://github.com/square/okhttp.git
synced 2025-11-23 06:42:24 +03:00
48 lines
1.2 KiB
Bash
Executable File
48 lines
1.2 KiB
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
|
|
|
|
REPO="git@github.com:square/okhttp.git"
|
|
DIR=temp-clone
|
|
|
|
# Delete any existing temporary website clone
|
|
rm -rf $DIR
|
|
|
|
# Clone the current repo into temp folder
|
|
git clone $REPO $DIR
|
|
# Replace `git clone` with these lines to hack on the website locally
|
|
# cp -a . "../okhttp-website"
|
|
# mv "../okhttp-website" "$DIR"
|
|
|
|
# Move working directory into temp folder
|
|
cd $DIR
|
|
|
|
# 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 and push the new files up to GitHub
|
|
mkdocs gh-deploy
|
|
|
|
# Restore Javadocs from 1.x, 2.x, and 3.x.
|
|
git checkout gh-pages
|
|
git cherry-pick bb229b9dcc9a21a73edbf8d936bea88f52e0a3ff
|
|
git cherry-pick c695732f1d4aea103b826876c077fbfea630e244
|
|
git push --set-upstream origin gh-pages
|
|
|
|
# Delete our temp folder
|
|
cd ..
|
|
rm -rf $DIR
|