docs: fix typos #30
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
| # GitHub Actions workflow to build Waystation docs using MyST. | |
| # | |
| # Copyright 2022-2024 California Institute of Technology. | |
| # License: Modified BSD 3-clause – see file "LICENSE" in the project website. | |
| # Website: https://github.com/caltechlibrary/waystation | |
| # 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 Sphinx docs & publish on GitHub Pages | |
| on: | |
| push: | |
| branches: ['main'] | |
| paths: ['docs/**'] | |
| release: | |
| types: [published] | |
| jobs: | |
| Workflow: | |
| name: Run Sphinx docs & publish GitHub Pages | |
| runs-on: ubuntu-22.04 | |
| permissions: | |
| contents: write | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Set up Python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: '3.8' | |
| - name: Upgrade pip | |
| run: | | |
| # Need pip=>20.1 to use "pip cache dir". | |
| python3 -m pip install --upgrade pip | |
| - name: Get pip cache dir | |
| id: pip-cache | |
| run: echo "dir=$(pip cache dir)" >> $GITHUB_OUTPUT | |
| - name: Cache dependencies | |
| uses: actions/cache@v3 | |
| with: | |
| path: ${{ steps.pip-cache.outputs.dir }} | |
| key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements-dev.txt') }} | |
| restore-keys: | | |
| ${{ runner.os }}-pip- | |
| - name: Install dependencies | |
| run: python3 -m pip install -r ./requirements-dev.txt | |
| - name: Generate HTML files | |
| run: | | |
| cd docs | |
| make html | |
| - name: Publish HTML files on GitHub pages | |
| uses: peaceiris/actions-gh-pages@v3 | |
| if: ${{ github.ref == 'refs/heads/main' }} | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: ./docs/_build/html |