Skip to content

Commit

Permalink
GitHub workflow to publish documentation
Browse files Browse the repository at this point in the history
Add a github action to build and deploy documentation to the GriHub pages.
  • Loading branch information
mknorps committed Dec 30, 2024
1 parent 76d9d96 commit ce7a0ab
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: Publish docs via GitHub Pages
# https://github.com/marketplace/actions/deploy-mkdocs
on:
push:
branches:
- main
- mknorps/documentation-init
workflow_dispatch:

jobs:
build:
name: Deploy docs
runs-on: ubuntu-latest
steps:
- name: Checkout main
uses: actions/checkout@v2

- name: Deploy docs
uses: mhausenblas/mkdocs-deploy-gh-pages@master
# Or use mhausenblas/mkdocs-deploy-gh-pages@nomaterial to build without the mkdocs-material theme
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
EXTRA_PACKAGES: build-base

0 comments on commit ce7a0ab

Please sign in to comment.