Fix typo #109
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 Sphinx Docs | |
on: | |
push: | |
branches: [main] | |
pull_request: | |
# If another web build starts for the same branch, cancel the previous build. This | |
# protects us from two builds trying to upload at the same time and clobbering each | |
# other. | |
concurrency: | |
group: ${{ github.workflow }}-${{ github.ref }} | |
cancel-in-progress: true | |
permissions: | |
contents: read | |
pages: write | |
id-token: write | |
pull-requests: write | |
jobs: | |
docs: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v3 | |
- uses: actions/setup-python@v4 | |
with: | |
python-version: '3.8' | |
- name: Install Poetry | |
run: curl -sSL https://install.python-poetry.org/ | python - | |
- name: Add Poetry to PATH | |
run: echo "$HOME/.poetry/bin" >> $GITHUB_PATH | |
- name: Install dependencies | |
run: poetry install | |
- name: Build HTML docs | |
run: poetry run make docs-ci | |
- name: Upload HTML docs | |
uses: actions/upload-artifact@v3 | |
with: | |
name: m3tid-docs-html | |
path: docs/_build/dirhtml/ | |
github_pages: | |
# This job only runs when committing or merging to main branch. | |
if: github.ref_name == 'main' | |
needs: docs | |
runs-on: ubuntu-latest | |
environment: | |
name: github-pages | |
url: $\{\{ steps.deployment.outputs.page_url \}\} | |
steps: | |
- name: Setup Pages | |
uses: actions/configure-pages@v2 | |
- name: Download HTML docs | |
uses: actions/download-artifact@v3 | |
with: | |
name: m3tid-docs-html | |
path: docs | |
- name: Upload artifact | |
uses: actions/upload-pages-artifact@v1 | |
with: | |
path: ./docs | |
- name: Deploy to GitHub Pages | |
id: deployment | |
uses: actions/deploy-pages@v1 |