plot fixes #19
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: Build and Deploy Documentation | ||
|
Check failure on line 1 in .github/workflows/docs.yml
|
||
| on: | ||
| # Runs on pushes targeting the default branch (main or master) | ||
| push: | ||
| branches: ["main", "master"] | ||
| # Allows you to run this workflow manually from the Actions tab | ||
| workflow_dispatch: | ||
| # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | ||
| permissions: | ||
| contents: read | ||
| pages: write | ||
| id-token: write | ||
| # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. | ||
| concurrency: | ||
| group: "pages" | ||
| cancel-in-progress: false | ||
| jobs: | ||
| # This job handles the entire build and deploy process for GitHub Pages | ||
| build-and-deploy-github: | ||
| if: env.GITHUB_ACTIONS == 'true' | ||
| runs-on: ubuntu-latest | ||
| environment: | ||
| name: github-pages | ||
| url: ${{ steps.deployment.outputs.page_url }} | ||
| steps: | ||
| - name: Checkout repository | ||
| uses: actions/checkout@v4 | ||
| - name: Set up Python | ||
| uses: actions/setup-python@v5 | ||
| with: | ||
| python-version: '3.10' | ||
| cache: 'pip' | ||
| - name: Install dependencies | ||
| run: pip install -e .[docs] | ||
| - name: Build documentation | ||
| run: sphinx-build -b html docs/source docs/build | ||
| - name: Upload artifact for GitHub Pages | ||
| uses: actions/upload-pages-artifact@v1 | ||
| with: | ||
| path: ./docs/build | ||
| - name: Deploy to GitHub Pages | ||
| id: deployment | ||
| uses: actions/deploy-pages@v4 | ||
| # This job handles the entire build and deploy process for Gitea | ||
| build-and-deploy-gitea: | ||
| # This job only runs on Gitea Actions | ||
| if: env.GITEA_ACTIONS == 'true' | ||
| 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' | ||
| cache: 'pip' | ||
| - name: Install dependencies | ||
| run: pip install -e .[docs] | ||
| - name: Build documentation | ||
| run: sphinx-build -b html docs/source docs/build | ||
| - name: Deploy to Gitea docs location | ||
| run: | | ||
| echo "Deploying documentation to Gitea's special directory..." | ||
| # The '/pages' directory is a mounted volume on the Gitea runner for serving static content. | ||
| sudo mkdir -p /pages/ | ||
| sudo cp -r ./docs/build/* /pages/ | ||
