Skip to content

Enhance the reading flow of the debugging section #34

Enhance the reading flow of the debugging section

Enhance the reading flow of the debugging section #34

Workflow file for this run

name: Deploy documentation
on:
push:
branches: ["master"]
# 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:
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Set up Python 3.11
uses: actions/setup-python@v3
with:
python-version: 3.11
- name: Install dependencies
run: |
python -m pip install --upgrade pip
python -m pip install pdoc3
python -m pip install -e .
- name: Build the documentation
run: |
pdoc --html clintest
- name: Setup Pages
uses: actions/configure-pages@v3
- name: Upload artifact
uses: actions/upload-pages-artifact@v2
with:
path: './html/clintest'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2