Skip to content

docs: modification of config to handle package reference correctly + … #34

docs: modification of config to handle package reference correctly + …

docs: modification of config to handle package reference correctly + … #34

Workflow file for this run

name: Publish updated version of the docs
on:
push:
branches:
- main
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
jobs:
build-docs:
name: Build HTML docs
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: "3.12"
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install .
pip install .[dev]
- name: Run Sphinx build
run: |
cd docs
make html
- name: Upload Sphinx HTML documentation as artifact
uses: actions/upload-pages-artifact@v3
with:
path: docs/build/html
deploy:
name: Deploy to GitHub pages
# Do not run this unless pushing to main.
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build-docs
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4