Build and deploy documentation. #22
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: Upload docs artifact | |
on: [push] | |
jobs: | |
Create-Docs: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Check out repository code | |
uses: actions/checkout@v4 | |
- name: Set up Python | |
uses: actions/setup-python@v4 | |
with: | |
python-version: "3.11" | |
- name: Install dependencies | |
run: | | |
python -m pip install --upgrade pip | |
pip install -r requirements.txt | |
pip install . | |
pip install -r docs_requirements.txt | |
- name: Create docs | |
run: mkdocs build | |
- name: Upload as artifact | |
uses: actions/upload-pages-artifact@v3 | |
with: | |
path: site | |
Upload-to-Pages: | |
if: github.ref == 'refs/heads/main' | |
needs: Create-Docs | |
permissions: | |
pages: write | |
id-token: write | |
environment: | |
name: github-pages | |
url: ${{ steps.deployment.outputs.page_url }} | |
runs-on: ubuntu-latest | |
steps: | |
- name: Deploy to GitHub Pages | |
id: deployment | |
uses: actions/deploy-pages@v4 |