Skip to content

Update docs.yml

Update docs.yml #18

Workflow file for this run

name: Deploy Sphinx Docs to GitHub Pages
on:
push:
branches: ["main"]
workflow_dispatch:
# Force GitHub Actions to use Node.js 24 for all steps
env:
FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: true
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.10'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install sphinx myst-parser sphinx-rtd-theme
- name: Build HTML documentation
run: |
# Build the documentation into the standard output folder
sphinx-build -b html docs/ docs/_build/html
- name: Fix Image Paths and Assets
run: |
# 1. Create the expected directory structure in the output
# Since your MD uses "../pica/assets", we create a 'pica' folder
# at the same level as your HTML files.
mkdir -p docs/_build/html/pica
cp -r pica/assets docs/_build/html/pica/
# 2. Copy the publications folder as you did before
cp -r publications/ docs/_build/html/publications/ || true
# 3. CRITICAL: Add .nojekyll to ensure GitHub Pages serves underscore folders
touch docs/_build/html/.nojekyll
- name: Upload GitHub Pages artifact
uses: actions/upload-pages-artifact@v3
with:
path: 'docs/_build/html'
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4