MNT: Refactor extension modules to use the same function names #102
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 Build" | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.event.number }}-${{ github.event.ref }} | |
| cancel-in-progress: true | |
| on: | |
| - pull_request | |
| - release | |
| jobs: | |
| docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| # sets up the compiler paths automatically for us | |
| - uses: fortran-lang/setup-fortran@v1 | |
| id: setup-fortran | |
| with: | |
| compiler: gcc | |
| version: 13 | |
| - name: Set up Python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: '3.13' | |
| - name: Download source files | |
| run: | | |
| python .github/workflows/download_mirror.py | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install .[docs] | |
| - name: Build documentation | |
| run: | | |
| cd docs | |
| make html | |
| - uses: actions/upload-artifact@v4 | |
| with: | |
| name: DocumentationHTML | |
| path: docs/build/html/ | |
| # Publish built docs to gh-pages branch | |
| - name: Commit documentation changes | |
| # push docs only when a GitHub Release is made | |
| if: github.event_name == 'release' && github.event.action == 'published' | |
| run: | | |
| git clone https://github.com/SWxTREC/pymsis.git --branch gh-pages --single-branch gh-pages | |
| cp -r docs/build/html/* gh-pages/ | |
| cd gh-pages | |
| git config --local user.email "[email protected]" | |
| git config --local user.name "GitHub Action" | |
| git add . | |
| git commit -m "Update documentation" -a || true | |
| # The above command will fail if no changes were present, so we ignore that. | |
| - name: Publish docs | |
| # push docs only when a GitHub Release is made | |
| if: github.event_name == 'release' && github.event.action == 'published' | |
| uses: ad-m/github-push-action@master | |
| with: | |
| branch: gh-pages | |
| directory: gh-pages | |
| github_token: ${{ secrets.GITHUB_TOKEN }} |