Skip to content

DOC: condensed

DOC: condensed #10

Workflow file for this run

name: build and publish documentation
on:
push:
branches:
- main
tags:
- '*'
# 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 only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: checkout
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: set up python 3.10
uses: actions/setup-python@v5
with:
python-version: "3.10"
- name: install package
run: |
python -m pip install --upgrade pip
pip install .[docs]
pip list
- name: build docs
run: |
cd docs
make html SPHINXOPTS="-j auto"
cd ..
- name: setup pages
uses: actions/configure-pages@v5
- name: upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: 'docs/_build/html'
deploy:
# Add a dependency to the build job
needs: build
# Deploy to the github-pages environment
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4