WIP: Attempt to build pydantic extension #36
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: Build & publish docs | |
on: | |
push: | |
branches: | |
- main | |
workflow_dispatch: | |
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | |
permissions: | |
contents: read | |
pages: write | |
id-token: write | |
jobs: | |
build: | |
name: Build | |
runs-on: ubuntu-latest | |
steps: | |
- name: ⬇ Checkout docs | |
uses: actions/checkout@v4 | |
with: | |
path: docs | |
- name: 🐍 Set up Python 3.11 | |
uses: actions/setup-python@v4 | |
with: | |
python-version: "3.11" | |
- name: 🐍 Preinstall some build dependencies | |
run: | | |
pip install --upgrade pip | |
pip install poetry | |
- name: 🐍 Install docs dependencies | |
run: | | |
cd ${{ github.workspace }}/docs | |
poetry install | |
- name: ⬇ Checkout OctoPrint | |
uses: actions/checkout@v4 | |
with: | |
repository: "OctoPrint/OctoPrint" | |
ref: improve/mkdocstrings | |
path: OctoPrint | |
- name: 🏗 Build docs | |
run: | | |
cd ${{ github.workspace }}/docs | |
export OCTOPRINT_SRC="${{ github.workspace }}/OctoPrint/src" | |
poetry run mkdocs build | |
env: | |
SITE_URL: https://mkdocs.octoprint.org | |
- name: ⬆ Upload pages artifact | |
uses: actions/upload-pages-artifact@v2 | |
with: | |
path: ./docs/site | |
publish: | |
name: Publish | |
runs-on: ubuntu-latest | |
needs: build | |
environment: | |
name: github-pages | |
url: ${{ steps.deployment.outputs.page_url }} | |
steps: | |
- name: 🚀 Deploy to GitHub Pages | |
id: deployment | |
uses: actions/deploy-pages@v2 |