Skip to content

Merge pull request #209 from boegel/2023a #123

Merge pull request #209 from boegel/2023a

Merge pull request #209 from boegel/2023a #123

Workflow file for this run

---
# documentation: https://help.github.com/en/articles/workflow-syntax-for-github-actions
name: deploy EasyBuild documentation (only on push to main branch)
on: # yamllint disable-line rule:truthy
push:
branches: main
permissions:
contents: write # to fetch code (actions/checkout) + deploy docs to GitHub Pages (gh-pages branch)
jobs:
build-docs:
runs-on: ubuntu-latest
steps:
- name: checkout
uses: actions/checkout@v3
with:
fetch-depth: 0
- name: set up Python
uses: actions/setup-python@v4
with:
python-version: '3.10'
- name: checkout easybuild framework
uses: actions/checkout@v3
with:
repository: easybuilders/easybuild-framework
path: src/easybuild-framework
ref: main
- name: install mkdocs
run: |
pip install -r requirements.txt
mkdocs --version
- name: build docs
# can't use --strict due to warnings being produced by mkdocs-redirect plugin
# because we are re-directing .html pages
# run: mkdocs build --strict
run: mkdocs build
- name: deploy docs
run: mkdocs gh-deploy --force