xref: /aosp_15_r20/external/okio/.buildscript/prepare_mkdocs.sh (revision f9742813c14b702d71392179818a9e591da8620c)
1*f9742813SAndroid Build Coastguard Worker#!/bin/bash
2*f9742813SAndroid Build Coastguard Worker
3*f9742813SAndroid Build Coastguard Worker# The website is built using MkDocs with the Material theme.
4*f9742813SAndroid Build Coastguard Worker# https://squidfunk.github.io/mkdocs-material/
5*f9742813SAndroid Build Coastguard Worker# It requires Python to run.
6*f9742813SAndroid Build Coastguard Worker# Install the packages with the following command:
7*f9742813SAndroid Build Coastguard Worker# pip install mkdocs mkdocs-material
8*f9742813SAndroid Build Coastguard Worker
9*f9742813SAndroid Build Coastguard Workerset -ex
10*f9742813SAndroid Build Coastguard Worker
11*f9742813SAndroid Build Coastguard Worker# Generate the API docs
12*f9742813SAndroid Build Coastguard Worker./gradlew dokkaHtml
13*f9742813SAndroid Build Coastguard Worker
14*f9742813SAndroid Build Coastguard Worker# Copy in special files that GitHub wants in the project root.
15*f9742813SAndroid Build Coastguard Workercp CHANGELOG.md docs/changelog.md
16*f9742813SAndroid Build Coastguard Workercp CONTRIBUTING.md docs/contributing.md
17