Skip to content

fix: cleanup the Ribbon API and documentation #2

fix: cleanup the Ribbon API and documentation

fix: cleanup the Ribbon API and documentation #2

Workflow file for this run

name: Update documentation
# TODO: We may only want to do this for tagged releases in the future
on:
push:
branches:
- main
paths:
- docs/**
- mkdocs.yml
jobs:
mkdocs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Install mkdocs
run: |
pip install --user mkdocs
pip install --user mkdocs-material
- name: Deploy GitHub Pages
run: |
mkdocs build
git worktree add gh-pages gh-pages
git config user.name "Deploy from CI"
git config user.email ""
cd gh-pages
# Delete the ref to avoid keeping history.
git update-ref -d refs/heads/gh-pages
rm -rf *
mv ../site/* .
git add .
git commit -m "Deploy $GITHUB_SHA to gh-pages"
git push --force