Skip to content

📃 docs: Add sponsor to README #15

📃 docs: Add sponsor to README

📃 docs: Add sponsor to README #15

Workflow file for this run

# Simple workflow for deploying static content to GitHub Pages
name: Build Docs
on:
workflow_dispatch:
push:
branches:
- main
paths:
- "**"
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
# Single deploy job since we're just deploying
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Pages
uses: actions/configure-pages@v5
- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: '3.12'
- name: Build Docs
run: |
cd docs
sudo apt-get install -y python3-sphinx
pip3 install -r requirements.txt
sphinx-build -M html ./ ./build
- name: Set up JDK 8
uses: actions/setup-java@v4
with:
distribution: 'corretto'
java-version: '8'
- name: Setup Gradle
uses: gradle/actions/setup-gradle@v4
with:
gradle-version: 8.10.2
- name: Build Javadoc
run: gradle javadoc
- name: Copy Javadoc
run: cp -rf build/docs/javadoc docs/build/html/reference
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
# Upload entire repository
path: 'docs/build/html'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4