-
Notifications
You must be signed in to change notification settings - Fork 121
/
prepare_docs.sh
executable file
·47 lines (37 loc) · 1.41 KB
/
prepare_docs.sh
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
#!/usr/bin/env 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:
# Install the packages: `pip install mkdocs-material`
# Build the api docs: `./gradlew dokkaHtmlMultiModule`
# Then run this script to prepare the docs for the website.
# Finally, run `mkdocs serve` to preview the site locally or `mkdocs build` to build the site.
set -ex
# Copy the changelog into the site, omitting the unreleased section
cat CHANGELOG.md \
| grep -v '^## Unreleased' \
| sed '/^## /,$!d' \
> docs/changelog.md
# Add the jinja frontmatter to the index
cat > docs/index.md <<- EOM
---
hide:
- toc # Hide table of contents
---
EOM
# Copy the README into the index, omitting the license, docs links, and fixing hrefs
cat README.md \
| sed 's:docs/img:img:g' \
| sed -e '/## Documentation/,/(runsample)\./d' \
| sed '/## License/Q' \
>> docs/index.md
# Add some extra links to the index page
cat >> docs/index.md <<- EOM
# API Reference
* [Commands and Exceptions](api/clikt/com.github.ajalt.clikt.core/)
* [Options](api/clikt/com.github.ajalt.clikt.parameters.options/)
* [Arguments](api/clikt/com.github.ajalt.clikt.parameters.arguments/)
* [Parameter Type Conversions](api/clikt/com.github.ajalt.clikt.parameters.types/)
* [Output Formatting](api/clikt/com.github.ajalt.clikt.output/)
EOM