Rename one of the functions #2811
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 Documents | |
| on: [push, pull_request] | |
| env: | |
| LANG: "en_US.UTF-8" | |
| LC_ALL: "en_US.UTF-8" | |
| PIP_DISABLE_PIP_VERSION_CHECK: "ON" | |
| PIP_NO_CLEAN: "ON" | |
| PIP_PREFER_BINARY: "ON" | |
| TZ: "UTC" | |
| FORD_FILE: "API-doc-FORD-file.md" | |
| jobs: | |
| Build-API-Docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v2 | |
| - uses: actions/setup-python@v1 | |
| with: | |
| python-version: '3.x' | |
| - name: Install dependencies | |
| run: | | |
| pip install -v ford==7.0.5 | |
| pip install fypp | |
| python --version | |
| ford --version | |
| fypp --version | |
| - name: Skip graph and search unless deploying | |
| if: github.ref != 'refs/heads/master' && ! startsWith( github.ref, 'refs/tags/' ) | |
| run: | | |
| sed -i 's/^[[:blank:]]*graph: *[Tt]rue/graph: false/' "${FORD_FILE}" | |
| echo "MAYBE_SKIP_SEARCH=--no-search" >> $GITHUB_ENV | |
| - name: Build Docs | |
| run: | | |
| git fetch --all --tags | |
| ford -r $(git describe --always) --debug ${MAYBE_SKIP_SEARCH} "${FORD_FILE}" | |
| - name: Upload Documentation | |
| uses: actions/upload-artifact@v2 | |
| with: | |
| name: FORD-API-docs | |
| path: ./API-doc/ | |
| - name: Broken Link Check | |
| uses: technote-space/broken-link-checker-action@v1 | |
| with: | |
| TARGET: file://${{ github.workspace }}/API-doc/index.html | |
| RECURSIVE: true | |
| ASSIGNEES: ${{ github.actor }} | |
| - name: Deploy API Docs | |
| uses: peaceiris/actions-gh-pages@v3 | |
| if: github.event_name == 'push' && github.repository == 'fortran-lang/stdlib' && ( startsWith( github.ref, 'refs/tags/' ) || github.ref == 'refs/heads/master' ) | |
| with: | |
| deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }} | |
| cname: 'stdlib.fortran-lang.org' | |
| external_repository: fortran-lang/stdlib-docs | |
| publish_dir: ./API-doc | |
| publish_branch: master | |
| allow_empty_commit: true | |
| force_orphan: false | |
| commit_message: "From https://github.com/${{ github.repository }}/commit/${{ github.sha }} ${{ github.ref }}" |