updated RTD #31
This file contains hidden or 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: Deploy Sphinx Docs to GitHub Pages | |
| on: | |
| push: | |
| branches: ["main"] | |
| workflow_dispatch: | |
| 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: | | |
| # 1. Build the documentation | |
| sphinx-build -b html docs/ docs/_build/html | |
| - name: Mirror Structure for Images | |
| run: | | |
| # This step makes "../pica/assets" work without changing your manual. | |
| # We create a folder structure inside the build output that matches | |
| # your relative paths. | |
| mkdir -p docs/_build/html/pica | |
| cp -r pica/assets docs/_build/html/pica/ | |
| # Copy publications folder | |
| cp -r publications/ docs/_build/html/publications/ || true | |
| # CRITICAL: Prevent GitHub from hiding folders starting with underscores | |
| 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 |