TCutility v0.10.0 #298
Workflow file for this run
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: 'Documentation' | |
| # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | |
| permissions: | |
| contents: write | |
| pages: write | |
| id-token: write | |
| # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. | |
| # However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. | |
| concurrency: | |
| group: "pages" | |
| cancel-in-progress: true | |
| on: | |
| push: | |
| branches: | |
| - main | |
| pull_request: | |
| types: [closed] | |
| branches: [main] | |
| release: | |
| types: [published] | |
| jobs: | |
| build_and_deploy: | |
| runs-on: ubuntu-latest | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@v3 | |
| - name: Get git tags | |
| run: git fetch --prune --unshallow --tags | |
| - name: Set up Python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: '3.11' | |
| - name: Build package | |
| run: | | |
| python -m pip install --upgrade pip | |
| if [ -f requirements.txt ]; then pip install -r requirements.txt; fi | |
| pip install -e . | |
| - name: Install sphinx | |
| run: pip install sphinx sphinx-tabs sphinx-copybutton | |
| - name: Install sphinx theme | |
| run: pip install pydata-sphinx-theme | |
| - name: Install other dependencies | |
| run: pip install plams | |
| - name: Run sphinx-apidoc | |
| run: cd docs; sphinx-apidoc -f -o ./api ../src/tcutility | |
| - name: Build the docs | |
| run: cd docs; make html | |
| - name: Upload build to repo | |
| uses: stefanzweifel/git-auto-commit-action@v4 | |
| with: | |
| commit_message: Documentation build | |
| file_pattern: 'docs/*' | |
| add_options: '-f' | |
| status_options: '-uall --ignored' | |
| push_options: '--force' | |
| branch: main | |
| - name: Setup Pages | |
| uses: actions/configure-pages@v3 | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v2 | |
| with: | |
| # Upload entire repository | |
| path: './docs/_build/html/' | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v2 |