Skip to content

Add documentation

Add documentation #1

Workflow file for this run

name: Docs
on:
push:
branches:
- main
pull_request:
branches:
- main
jobs:
build:
name: Build documentation
runs-on: ubuntu-22.04
steps:
- name: Checkout
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11
- name: Set up JDK
uses: actions/setup-java@387ac29b308b003ca37ba93a6cab5eb57c8f5f93
with:
java-version: "21"
distribution: "temurin"
- name: Set up Python
uses: actions/setup-python@0a5c61591373683505ea898e09a3ea4f39ef2b9c
with:
python-version: "3.12"
- name: Build documentation
run: ./gradlew --no-daemon clean mkdocsBuild javadoc
- name: Upload artifact
uses: actions/upload-pages-artifact@0252fc4ba7626f0298f0cf00902a25c6afc77fa8
with:
path: build/docs
if: ${{ github.ref == "refs/head/main" }}

Check failure on line 33 in .github/workflows/docs.yml

View workflow run for this annotation

GitHub Actions / Docs

Invalid workflow file

The workflow is not valid. .github/workflows/docs.yml (Line: 33, Col: 13): Unexpected symbol: '"refs/head/main"'. Located at position 15 within expression: github.ref == "refs/head/main" .github/workflows/docs.yml (Line: 45, Col: 9): Unexpected symbol: '"refs/head/main"'. Located at position 15 within expression: github.ref == "refs/head/main"
deploy:
name: Deploy to GitHub Pages
needs: build
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-22.04
if: ${{ github.ref == "refs/head/main" }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@87c3283f01cd6fe19a0ab93a23b2f6fcba5a8e42