Skip to content

Commit

Permalink
[QI2-1279] Publish documentation to GitHub pages (#19)
Browse files Browse the repository at this point in the history
  • Loading branch information
oschusler authored Jan 3, 2025
1 parent dd4dfaa commit 5b3b2c8
Show file tree
Hide file tree
Showing 14 changed files with 817 additions and 333 deletions.
51 changes: 51 additions & 0 deletions .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
name: Publish MkDocs

on:
pull_request:
push:
branches:
- master
release:
types:
- created

jobs:
build:
name: Publish documentation
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4

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

- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r requirements.txt
- name: Configure Git
run: |
git config --global user.name "${{ github.actor }}"
git config --global user.email "${{ github.actor_id }}+${{ github.actor }}@users.noreply.github.com"
git fetch origin gh-pages:gh-pages
- name: Dry run
if: github.event_name == 'pull_request'
run: |
mkdocs build
- name: Upload and tag as latest
if: github.ref == 'refs/heads/master'
run: |
mike deploy --push latest
mike set-default --push latest
- name: Upload and tag as git tag
if: github.event_name == 'release' && github.event.action == 'created'
run: |
mike deploy --push ${{ github.ref_name }}
mike set-default --push latest
11 changes: 0 additions & 11 deletions .github/workflows/linting.yaml

This file was deleted.

Loading

0 comments on commit 5b3b2c8

Please sign in to comment.