Skip to content

fix: DownloadButton default import #63

fix: DownloadButton default import

fix: DownloadButton default import #63

Workflow file for this run

# https://www.codingwiththomas.com/blog/my-sphinx-best-practice-for-a-multiversion-documentation-in-different-languages
name: Build docs
on:
push:
workflow_dispatch:
inputs:
deploy_docs:
type: boolean
description: 'Run the deploy-to-gh-pages step'
required: false
default: false
debug_enabled:
type: boolean
description: 'Run the build with tmate debugging enabled'
jobs:
build:
runs-on: ubuntu-latest
permissions:
id-token: write
pages: write
steps:
- uses: actions/checkout@v4
- name: Setup tmate session
uses: mxschmitt/action-tmate@v3
if: ${{ github.event_name == 'workflow_dispatch' && inputs.debug_enabled }}
- name: setup
env:
# Let pip install system packages without complaining if --break-system-packages is passed to pip <22
PIP_BREAK_SYSTEM_PACKAGES: 1
run: |
# ... installation of all tools ...
sudo apt-get install -y python3-pip
sudo pip3 install sphinx==7.4.7 sphinx-rtd-theme sphinxcontrib-images
- name: build
run: |
# get all tags, and run a python script
# which you find below to build all documents
git fetch --tags
cd docs
mkdir _build
python3 build_docs.py
- name: Setup Pages
if: github.ref_name == 'main'
uses: actions/configure-pages@v4
- name: Upload artifact
if: github.ref_name == 'main'
uses: actions/upload-pages-artifact@v3
with:
# Upload entire repository
path: './pages'
- name: Deploy to GitHub Pages
if: (github.ref_name == 'main' && github.event_name == 'push') || (github.event_name == 'workflow_dispatch' && inputs.deploy_docs)
id: deployment
uses: actions/deploy-pages@v4
with:
token: ${{ github.token }}