Documentation CI #299
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Documentation CI | |
on: | |
workflow_dispatch: | |
push: | |
branches: | |
- main | |
- feature/hardware-setup | |
pull_request: | |
branches: [ "main" ] | |
jobs: | |
deploy: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v3 | |
with: | |
# The branch, tag or SHA to checkout. When checking out the repository that | |
# triggered a workflow, this defaults to the reference or SHA for that event. | |
# Otherwise, uses the default branch. | |
# Default '' | |
ref: feature/hardware-setup | |
# Number of commits to fetch. 0 indicates all history for all branches and tags. | |
# Default: 1 | |
fetch-depth: 0 | |
# Whether to download Git-LFS files | |
# Default: false | |
lfs: '' | |
- uses: actions/setup-python@v2 | |
with: | |
python-version: 3.x | |
- run: pip install -r requirements.txt | |
- name: build documentation | |
run: mkdocs build | |
- name: deploy documentation | |
if: ${{ github.ref == 'refs/heads/main' }} | |
run: mkdocs gh-deploy --force |