Skip to content
This repository has been archived by the owner on Sep 19, 2023. It is now read-only.

Pages

Pages #12

Workflow file for this run

name: Pages
on:
release:
types: [created]
branches:
- 'master'
jobs:
build:
name: "Build docs"
runs-on: ubuntu-latest
steps:
- uses: actions/setup-python@v4
name: 'Set up Python 3.10'
with:
python-version: '3.10'
- uses: actions/checkout@v3
with:
fetch-depth: 0 # otherwise, you will failed to push refs to dest repo
- name: "Install deps and build with Sphinx"
run: >
pip install setuptools --upgrade &&
pip install -r ./docs/docs.txt &&
cd docs &&
make html
- name: "Upload artifacts"
uses: actions/upload-pages-artifact@v1
with:
# Upload built docs
path: "./docs/_build/html/"
deploy:
name: "Deploy docs"
needs: build
runs-on: ubuntu-latest
# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
permissions:
pages: write # to deploy to Pages
id-token: write # to verify the deployment originates from an appropriate source
# Deploy to the github-pages environment
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- uses: actions/deploy-pages@v1
id: deployment
name: "Deploy to GitHub Pages"