Skip to content

Publish docs

Publish docs #10

Workflow file for this run

name: Publish docs
on:
push:
# Want to remove it running on every commit eventually
branches:
- main
tags:
- v*
permissions:
contents: read
pages: write
id-token: write
jobs:
deploy_docs:
runs-on: macos-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- uses: actions/checkout@v4
- name: Setup JDK
uses: actions/setup-java@v3
with:
distribution: 'zulu'
java-version: 17
- name: Setup Python
uses: actions/setup-python@v4
with:
python-version: '3.x'
- name: Setup Pages
uses: actions/configure-pages@v3
- name: Install dependencies
run: |
python3 -m pip install --upgrade pip
python3 -m pip install mkdocs mkdocs-material mkdocs-video "mkdocs-material[imaging]"
- uses: gradle/gradle-build-action@v2
- run: ./gradlew :dokkaHtmlMultiModule
- name: Build site
run: mkdocs build
- name: Copy Dokka output to site
run: cp -r build/dokka/htmlMultiModule/ site/api/
- name: Upload artifact
uses: actions/upload-pages-artifact@v2
with:
path: 'site'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2