Skip to content

docs: Add JOSS publication badge #178

docs: Add JOSS publication badge

docs: Add JOSS publication badge #178

name: Documentation
# build the documentation whenever there are new commits on main
on:
push:
branches:
- master
# Alternative: only build for tags.
# tags:
# - '*'
# security: restrict permissions for CI jobs.
permissions:
contents: read
jobs:
# Build the documentation and upload the static HTML files as an artifact.
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Install uv
uses: astral-sh/setup-uv@v5
- name: Install dependencies
run: |
uv sync --extra docs --extra gym --extra gui --extra planning --extra htmlvis
- name: Make documentation
run: |
uv run pdoc -d google -t docs/template --logo https://irll.net/irll-logo.png --logo-link https://irll.github.io/HierarchyCraft/hcraft.html -o docs/build --math --no-search hcraft
- name: Upload static documentation artifact
uses: actions/upload-pages-artifact@v3
with:
path: docs/build
# Deploy the artifact to GitHub pages.
# This is a separate job so that only actions/deploy-pages has the necessary permissions.
deploy:
needs: build
runs-on: ubuntu-latest
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- id: deployment
uses: actions/deploy-pages@v4