[mod] use FORD6 on GitHub Actions to deploy docs. #1
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: FORD6 | |
| on: | |
| push: | |
| branches: [ "main" ] | |
| pull_request: | |
| branches: [ "main" ] | |
| jobs: | |
| documentation: | |
| runs-on: ${{ matrix.os }} | |
| permissions: | |
| contents: write | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| os: [ubuntu-latest] | |
| python-version: [3.12] | |
| steps: | |
| - name: Checkout Code | |
| uses: actions/checkout@v3 | |
| with: | |
| submodules: recursive | |
| - name: Install Python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: ${{ matrix.python-version}} | |
| - name: Setup Graphviz | |
| uses: ts-graphviz/setup-graphviz@v1 | |
| - name: Install FORD6 | |
| if: contains ( matrix.os, 'ubuntu') | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install 'FORD==6.2.5' | |
| if [ -f requirements.txt ]; then pip install -r requirement.txt; fi | |
| - name: Build FORD Documentation | |
| run: ford ./gen-ford.yml | |
| - name: Deploy Documentation | |
| uses: JamesIves/[email protected] | |
| with: | |
| branch: gh-pages | |
| folder: doc | |