Skip to content

Add URL builder functions (#178) #1

Add URL builder functions (#178)

Add URL builder functions (#178) #1

Workflow file for this run

name: Documentation
on:
push:
branches:
- main
workflow_dispatch:
permissions:
contents: write
jobs:
build-and-deploy:
name: Build and Deploy Documentation
runs-on: ubuntu-24.04
steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
submodules: recursive
- name: Install system dependencies
run: |
sudo apt-get update
sudo apt-get install -y \
doxygen \
pandoc \
python3 \
python3-pip \
ninja-build
- name: Install Python documentation dependencies
run: |
python3 -m pip install --upgrade pip
python3 -m pip install \
sphinx \
sphinx_bootstrap_theme \
breathe \
recommonmark
- name: Install vcpkg
run: |
git clone https://github.com/Microsoft/vcpkg.git
./vcpkg/bootstrap-vcpkg.sh
- name: Configure CMake
run: |
cmake \
-B build \
-G Ninja \
-DCMAKE_BUILD_TYPE=Release \
-DCMAKE_TOOLCHAIN_FILE=${{ github.workspace }}/vcpkg/scripts/buildsystems/vcpkg.cmake \
.
- name: Build documentation
run: cmake --build build --target doc
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./build/docs/html
publish_branch: gh-pages
user_name: 'github-actions[bot]'
user_email: 'github-actions[bot]@users.noreply.github.com'
commit_message: 'Deploy documentation from ${{ github.sha }}'