Build gh-pages for latest release #39
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
| # ============================================================================= | |
| # @file build-docs.yml | |
| # @brief GitHub Actions workflow to build Boffo docs using MyST | |
| # @author Michael Hucka <[email protected]> | |
| # @license Please see the file named LICENSE in the project directory | |
| # @website https://github.com/caltechlibrary/boffo | |
| # | |
| # This workflow file was originally based on work by GitHub user "peaceiris": | |
| # https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-static-site-generators-with-python | |
| # ============================================================================= | |
| name: Build docs for gh-pages | |
| run-name: Build gh-pages for ${{inputs.release_tag || 'latest release'}} | |
| on: | |
| push: | |
| branches: ['main'] | |
| paths: ['docs/**'] | |
| jobs: | |
| deploy: | |
| runs-on: ubuntu-20.04 | |
| steps: | |
| - uses: actions/checkout@v2 | |
| - name: Set up Python | |
| uses: actions/setup-python@v2 | |
| with: | |
| python-version: '3.8' | |
| - name: Upgrade pip | |
| run: | | |
| # install pip=>20.1 to use "pip cache dir" | |
| python3 -m pip install --upgrade pip | |
| - name: Get pip cache dir | |
| id: pip-cache | |
| run: echo "::set-output name=dir::$(pip cache dir)" | |
| - name: Cache dependencies | |
| uses: actions/cache@v2 | |
| with: | |
| path: ${{ steps.pip-cache.outputs.dir }} | |
| key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }} | |
| restore-keys: | | |
| ${{ runner.os }}-pip- | |
| - name: Install dependencies | |
| run: | | |
| python3 -m pip install "myst-parser[linkify]" | |
| python3 -m pip install sphinx-material | |
| python3 -m pip install sphinxcontrib-mermaid | |
| - name: Build | |
| run: | | |
| cd docs | |
| make html | |
| - name: Deploy | |
| uses: peaceiris/actions-gh-pages@v3 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: ./docs/_build/html |