Skip to content

Tweaks to the documentation (#43) #21

Tweaks to the documentation (#43)

Tweaks to the documentation (#43) #21

Workflow file for this run

name: Publish docs via GitHub Pages
on:
push:
branches:
- master
jobs:
build:
name: Deploy docs
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Rye with caching of venvs
uses: eifinger/setup-rye@v4
id: setup-rye
with:
enable-cache: true
github-token: ${{ secrets.GITHUB_TOKEN }}
- name: Pin python-version
run: rye pin 3.10
- name: Install dependencies
run: rye sync --no-lock --features docs
- name: Deploy docs
run: rye run mkdocs gh-deploy --force
# note: Checking if we really need the one below:
# uses: mhausenblas/[email protected]
# # Or use mhausenblas/mkdocs-deploy-gh-pages@nomaterial to build without the mkdocs-material theme
# env:
# GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}