Build and Deploy Documentation and Website #290
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: Build and Deploy Documentation and Website | |
| on: | |
| push: | |
| branches: | |
| - main | |
| pull_request: | |
| workflow_dispatch: | |
| jobs: | |
| Build: | |
| runs-on: ubuntu-24.04 | |
| steps: | |
| # | |
| # Checks-out repository under $GITHUB_WORKSPACE | |
| # | |
| - uses: actions/checkout@v4 | |
| # | |
| # Install dependencies | |
| # | |
| - name: Install dependencies | |
| run: | | |
| sudo apt-get update | |
| sudo apt-get install graphviz | |
| sudo pip install 'markdown<3.4' ford | |
| # | |
| # Build documentation | |
| # | |
| - name: Build FORD files | |
| id: build | |
| run: | | |
| cd docs | |
| ford ford_templates/rrtmgp-fortran-interface.md | |
| ford ford_templates/rrtmgp-kernels.md | |
| ford ford_templates/rte-fortran-interface.md | |
| ford ford_templates/rte-kernels.md | |
| # | |
| # Deploy | |
| # | |
| - name: Deploy to Github Pages root | |
| uses: JamesIves/github-pages-deploy-action@v4.7.3 | |
| if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }} | |
| with: | |
| branch: gh-pages | |
| folder: docs/ | |
| # | |
| # Deploy (temporary) | |
| # | |
| - name: Deploy to Github Pages root | |
| uses: JamesIves/github-pages-deploy-action@v4.7.3 | |
| if: ${{ github.event_name == 'workflow_dispatch' }} | |
| with: | |
| branch: gh-pages | |
| folder: docs/ |