Python API updates #1123
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: Build and Deploy Documentation | |
| on: [push, pull_request, workflow_dispatch] | |
| jobs: | |
| documentation: | |
| runs-on: ubuntu-22.04 | |
| env: | |
| FC: gfortran | |
| GCC_V: 12 | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v3 | |
| - name: Install Dependencies Ubuntu | |
| run: | | |
| sudo apt-get update | |
| sudo apt install -y gfortran-${GCC_V} python3-dev graphviz pandoc | |
| sudo pip install ford markdown | |
| pip install -r python/docs/requirements.txt | |
| - name: Build Developer Documentation | |
| run: | | |
| ford ford.md | |
| cd python/docs | |
| sphinx-build -b html source build | |
| rm -r ../../doc/ford_site/page/python-api | |
| mv build ../../doc/ford_site/page/python-api | |
| cd ../../ | |
| touch doc/ford_site/.nojekyll | |
| - name: Upload Documentation | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: documentation | |
| path: doc/ford_site | |
| if-no-files-found: error | |
| - name: Broken Link Check | |
| if: ${{ github.ref == 'refs/heads/main'}} | |
| uses: technote-space/broken-link-checker-action@v1 | |
| with: | |
| TARGET: file://${{ github.workspace }}/ford_site/index.html | |
| RECURSIVE: true | |
| ASSIGNEES: ${{ github.actor }} | |
| - name: Deploy API Documentation | |
| uses: JamesIves/github-pages-deploy-action@4.1.0 | |
| if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }} | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| branch: gh-pages | |
| folder: doc/ford_site |