Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions .github/workflows/docs_deploy.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: "NDSL documentation"

# Documentation gets automatically deployed upon merge to develop
on:
push:
branches:
- develop

# Security: Restrict permissions of this workflow to whats needed.
permissions:
contents: write

jobs:
deploy:
runs-on: ubuntu-latest

steps:
- name: Checkout repository
uses: actions/checkout@v5

- name: Configure Git Credentials
run: |
git config user.name github-actions[bot]
git config user.email github-actions[bot]@users.noreply.github.com

- name: Setup python
uses: actions/setup-python@v5
with:
python-version: 3.11

- name: Install dependencies
run: pip install mkdocs-material mkdocstrings[python]

- name: Deploy docs to GitHub Pages
run: mkdocs gh-deploy --force