Files
foundry/.github/workflows/documentation.yml
Rachel Clune bcfa500c75 Add step to disable Jekyll in documentation build
Right now going to the GH pages site just shows the README, this is likely because GH is only building the README with Jekyll even though this workflow should override it without the added lines.
2026-01-02 11:34:48 -08:00

30 lines
846 B
YAML

name: documentation
on: [push, pull_request, workflow_dispatch]
permissions:
contents: write
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
- name: Install dependencies
run: |
pip install sphinx myst_parser furo sphinx-copybutton
- name: Sphinx build
run: |
sphinx-build -M html docs/source/ docs/build/
- name: Disable Jekyll
run: touch docs/build/html/.nojekyll
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/production' }}
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/build/html
force_orphan: true