Update changelog.rst #112
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
# Workflow to build the docs (with sphinx) and deploy the build to GitHub Pages | |
# note: parts of this workflow were copied directly from GitHub's suggested workflows | |
name: Build and deploy docs | |
on: | |
# Runs on pushes targeting the default branch | |
push: | |
branches: ["main"] | |
# Allows you to run this workflow manually from the Actions tab | |
workflow_dispatch: | |
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | |
permissions: | |
contents: read | |
pages: write | |
id-token: write | |
# Allow one concurrent deployment | |
concurrency: | |
group: "pages" | |
cancel-in-progress: true | |
jobs: | |
build: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout | |
uses: actions/checkout@v3 | |
- name: Setup Pages | |
id: pages | |
uses: actions/configure-pages@v3 | |
- name: Install dependencies | |
working-directory: ./docs | |
run: | | |
python -m pip install --upgrade pip | |
pip install -r requirements-docs.txt | |
- name: Build the docs | |
working-directory: ./docs | |
run: make build | |
- name: Upload build artifacts | |
uses: actions/upload-pages-artifact@v1 | |
with: | |
path: './docs/build/html' | |
deploy: | |
environment: | |
name: github-pages | |
url: ${{ steps.deployment.outputs.page_url }} | |
runs-on: ubuntu-latest | |
needs: build | |
steps: | |
- name: Deploy to GitHub Pages | |
id: deployment | |
uses: actions/deploy-pages@v1 |