Skip to content

Commit

Permalink
CI for automated documentation update
Browse files Browse the repository at this point in the history
  • Loading branch information
xmatthias committed Aug 3, 2024
1 parent 5f13f1c commit c842296
Showing 1 changed file with 44 additions and 0 deletions.
44 changes: 44 additions & 0 deletions .github/workflows/deploy-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
name: Build Documentation

on:
push:
branches:
- main
release:
types: [published]


# disable permissions for all of the available permissions
permissions: {}


jobs:
build-docs:
permissions:
contents: write # for mike to push
name: Deploy Docs through mike
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.12'

- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r docs/requirements-docs.txt
- name: Configure Git user
run: |
git config --local user.email "github-actions[bot]@users.noreply.github.com"
git config --local user.name "github-actions[bot]"
- name: Build and push Mike
run: |
mike deploy ${{ github.ref_name }} latest --push --update-aliases
mike set-default --push latest

0 comments on commit c842296

Please sign in to comment.