xref: /aosp_15_r20/external/accompanist/generate_docs.sh (revision fa44fe6ae8e729aa3cfe5c03eedbbf98fb44e2c6)
1*fa44fe6aSInna Palant#!/bin/bash
2*fa44fe6aSInna Palant
3*fa44fe6aSInna Palant# Copyright 2021 The Android Open Source Project
4*fa44fe6aSInna Palant#
5*fa44fe6aSInna Palant# Licensed under the Apache License, Version 2.0 (the "License");
6*fa44fe6aSInna Palant# you may not use this file except in compliance with the License.
7*fa44fe6aSInna Palant# You may obtain a copy of the License at
8*fa44fe6aSInna Palant#
9*fa44fe6aSInna Palant#      https://www.apache.org/licenses/LICENSE-2.0
10*fa44fe6aSInna Palant#
11*fa44fe6aSInna Palant# Unless required by applicable law or agreed to in writing, software
12*fa44fe6aSInna Palant# distributed under the License is distributed on an "AS IS" BASIS,
13*fa44fe6aSInna Palant# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14*fa44fe6aSInna Palant# See the License for the specific language governing permissions and
15*fa44fe6aSInna Palant# limitations under the License.
16*fa44fe6aSInna Palant
17*fa44fe6aSInna Palant# Fail on any error
18*fa44fe6aSInna Palantset -ex
19*fa44fe6aSInna Palant
20*fa44fe6aSInna PalantDOCS_ROOT=docs-gen
21*fa44fe6aSInna Palant
22*fa44fe6aSInna Palant[ -d $DOCS_ROOT ] && rm -r $DOCS_ROOT
23*fa44fe6aSInna Palantmkdir $DOCS_ROOT
24*fa44fe6aSInna Palant
25*fa44fe6aSInna Palant# Clear out the old API docs
26*fa44fe6aSInna Palant[ -d docs/api ] && rm -r docs/api
27*fa44fe6aSInna Palant# Build the docs with dokka
28*fa44fe6aSInna Palant./gradlew dokkaHtmlMultiModule --stacktrace
29*fa44fe6aSInna Palant
30*fa44fe6aSInna Palant# Create a copy of our docs at our $DOCS_ROOT
31*fa44fe6aSInna Palantcp -a docs/* $DOCS_ROOT
32*fa44fe6aSInna Palant
33*fa44fe6aSInna Palantcp README.md $DOCS_ROOT/index.md
34*fa44fe6aSInna Palantcp CONTRIBUTING.md $DOCS_ROOT/contributing.md
35*fa44fe6aSInna Palant
36*fa44fe6aSInna Palantsed -i.bak 's/CONTRIBUTING.md/contributing/' $DOCS_ROOT/index.md
37*fa44fe6aSInna Palantsed -i.bak 's/README.md//' $DOCS_ROOT/index.md
38*fa44fe6aSInna Palantsed -i.bak 's/docs\/header.png/header.png/' $DOCS_ROOT/index.md
39*fa44fe6aSInna Palant
40*fa44fe6aSInna Palant# Convert docs/xxx.md links to just xxx/
41*fa44fe6aSInna Palantsed -i.bak 's/docs\/\([a-zA-Z-]*\).md/\1/' $DOCS_ROOT/index.md
42*fa44fe6aSInna Palant
43*fa44fe6aSInna Palant# Finally delete all of the backup files
44*fa44fe6aSInna Palantfind . -name '*.bak' -delete
45