Skip to content

Update release.yml

Update release.yml #6

Workflow file for this run

# Deploy Sphinx content to GitHub Pages
name: Deploy Sphinx documentation
on:
# Runs on pushes targeting the default branch
push:
branches: ["main"]
release:
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:
name: Build the documentation with Sphinx
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- run: git fetch origin main
- name: troubleshooting
run: |
git branch
git remote -v
- uses: actions/setup-python@v5
with:
python-version: '3.11'
- name: Install package
run: |
sudo apt-get install -y doxygen graphviz
pip install -e .[docs]
pip install -r requirements.txt
- name: Build documentation
run: sphinx-build docs/ docs/_build/html
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: 'docs/_build/html'
deploy:
name: Deploy documentation to GitHub Pages
needs: build
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Setup Pages
uses: actions/configure-pages@v5
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
with:
base_path: /sansmic/${{ github.ref_name }}