Skip to content

Documentation improvements. #5

Documentation improvements.

Documentation improvements. #5

Workflow file for this run

name: API Documentation
on: [push, workflow_dispatch]
permissions:
contents: write
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
submodules: "true"
- name: Install Doxygen
shell: bash
run: sudo apt-get install doxygen
- name: Create Build Environment
run: cmake -E make_directory build
- name: Configure CMake
# Use a bash shell, so we can use the same syntax for environment variable
# access regardless of the host operating system
shell: bash
working-directory: ${{github.workspace}}/build
# Note the current convention is to use the -S and -B options here to specify source
# and build directories, but this is only available with CMake 3.13 and higher.
# The CMake binaries on the GitHub Actions machines are (as of this writing) 3.12
run: cmake $GITHUB_WORKSPACE -DCMAKE_BUILD_TYPE=Release
- name: Build Documentation
working-directory: ${{github.workspace}}/build
shell: bash
run: cmake --build . --config Release --target doxygen
- name: Create .nojekyll (ensures pages with underscores work on gh pages)
shell: bash
run: touch build/doc/html/.nojekyll
- name: Deploy to GitHub Pages
uses: JamesIves/github-pages-deploy-action@v4
with:
branch: gh-pages
folder: build/doc/html
# target-folder: /