Remember to checkout repo in steps #3
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: Main docs 📖 | |
on: | |
push: | |
branches: [main] | |
workflow_call: | |
permissions: | |
contents: write | |
jobs: | |
build-julia: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout repo | |
uses: actions/checkout@v4 | |
- name: Setup Julia | |
uses: julia-actions/setup-julia@v2 | |
with: | |
version: "1" | |
project: './julia' | |
- name: Use Julia cache | |
uses: julia-actions/cache@v2 | |
- name: Generate Julia documentation | |
run: julia --project=docs docs/make.jl | |
working-directory: julia | |
- name: Upload build as artifact | |
id: deployment | |
uses: actions/upload-artifact@v4 | |
with: | |
name: julia-docs | |
path: julia/docs/build/ | |
build-python: | |
runs-on: ubuntu-latest | |
defaults: | |
run: | |
working-directory: python | |
steps: | |
- name: Checkout repo | |
uses: actions/checkout@v4 | |
- name: Setup Python | |
uses: actions/setup-python@v5 | |
with: | |
python-version: "3.13" | |
cache: "pip" | |
- name: Install docs requirements | |
run: pip install -r docs/requirements.txt | |
- name: Build Python docs | |
run: make -C python/docs/ html | |
- name: Upload build as artifact | |
id: deployment | |
uses: actions/upload-artifact@v4 | |
with: | |
name: python-docs | |
path: docs/_build/html | |
build-main: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout repo | |
uses: actions/checkout@v4 | |
- name: Setup Python | |
uses: actions/setup-python@v5 | |
with: | |
python-version: "3.13" | |
cache: "pip" | |
- name: Install mkdocs | |
run: pip install mkdocs-material | |
- name: Build mkdocs | |
run: mkdocs build -d html | |
- name: Upload build as artifact | |
id: deployment | |
uses: actions/upload-artifact@v4 | |
with: | |
name: main-docs | |
path: html | |
publish-docs: | |
runs-on: ubuntu-latest | |
needs: | |
- build-julia | |
- build-python | |
- build-main | |
steps: | |
- name: Download Julia build | |
uses: actions/download-artifact@v4 | |
with: | |
name: julia-docs | |
path: julia | |
- name: Download Python build | |
uses: actions/download-artifact@v4 | |
with: | |
name: python-docs | |
path: python | |
- name: Download main build | |
uses: actions/download-artifact@v4 | |
with: | |
name: main-docs | |
path: . | |
- name: Deploy to GitHub Pages | |
id: deployment | |
uses: actions/deploy-pages@v4 |