chore: [WIP] Moving off and off-pro to off2 #220
Workflow file for this run
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
--- | |
#---------------------------------------------- | |
# Generate and upload documentation (only push to main) | |
#---------------------------------------------- | |
name: Generate documentation | |
on: | |
pull_request: | |
# on pull request we just want to build to see nothing is broken | |
paths: | |
- "README.md" | |
- "docs/**" | |
- ".github/workflows/generate-docs.yml" | |
- "mkdocs.yml" | |
push: | |
branches: | |
- develop | |
jobs: | |
build-docs: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Check out the repo | |
uses: actions/checkout@v3 | |
- uses: actions/setup-python@v2 | |
with: | |
python-version: 3.x | |
- name: Install mkdocs requirements | |
run: | | |
pip install mkdocs-material mdx_truly_sane_lists mkdocs-glightbox mdx-breakless-lists | |
- name: Generate documentation | |
run: | | |
bash scripts/build_mkdocs.sh | |
mkdocs build | |
- name: Deploy documentation to Github Pages 🚀 | |
# we only deploy on push to main | |
if: | | |
github.event_name == 'push' && github.event.ref == 'refs/heads/develop' | |
uses: JamesIves/[email protected] | |
with: | |
token: ${{ secrets.GITHUB_TOKEN }} | |
branch: gh-pages # The branch the action should deploy to. | |
folder: gh_pages # The folder the action should deploy. | |
clean: true # Automatically remove deleted files from the deploy branc |