mirror of
https://github.com/slsdetectorgroup/slsDetectorPackage.git
synced 2026-01-22 05:54:29 +01:00
69 lines
1.8 KiB
YAML
69 lines
1.8 KiB
YAML
name: Build and upload Documentation
|
|
|
|
on:
|
|
workflow_dispatch:
|
|
push: # Only for Testing change later
|
|
|
|
|
|
env:
|
|
BUILD_TYPE: RELEASE
|
|
|
|
|
|
jobs:
|
|
build:
|
|
strategy:
|
|
matrix:
|
|
patform: [ubuntu-latest]
|
|
python-version: ["3.12"]
|
|
runs-on: ${{ matrix.patform }}
|
|
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
|
|
- name: Install System Packages
|
|
uses: awalsh128/cache-apt-pkgs-action@latest
|
|
with:
|
|
packages: libhdf5-dev doxygen
|
|
version: 1.0
|
|
|
|
- name: Install Python Packages
|
|
uses: actions/setup-python@v5
|
|
with:
|
|
python-version: 3.12
|
|
cache: 'pip'
|
|
run: pip install sphinx sphinx_rtd_theme breathe
|
|
|
|
|
|
- name: Build Documentation
|
|
run: |
|
|
mkdir build
|
|
cd build
|
|
cmake -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} -DSLS_BUILD_DOCS=ON -DSLS_USE_HDF5=ON -DSLS_USE_PYTHON=ON ..
|
|
make -j4
|
|
make docs
|
|
|
|
- name: Upload Documentation Artifact
|
|
uses: actions/upload-pages-artifact@v4
|
|
with:
|
|
path: build/docs/html # maybe we need to upload images as well - so one can click on them?
|
|
|
|
|
|
deploy:
|
|
environment:
|
|
name: github-pages
|
|
needs: build
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Deploy to GitHub Pages
|
|
id: deployment
|
|
uses: actions/deploy-pages@v1
|
|
with:
|
|
branch: gh-pages # visible branch for Pages
|
|
#folder: "v${{ github.ref_name }}" # deploy to version subfolder
|
|
folder: "."
|
|
|
|
|
|
|
|
|
|
|