Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add doxygen build test workflow #67

Merged
merged 4 commits into from
Aug 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions .github/workflows/doxygen-build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: Doxygen build test

on:
pull_request:
branches:
- main

jobs:
test:
defaults:
run:
shell: bash

runs-on: macos-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
submodules: "true"

- name: Install dependencies - macos
run: brew install hdf5 boost catch2 doxygen graphviz

- name: Configure
shell: pwsh
run: cmake "--preset=ci-macos"

- name: Build
run: cmake --build build

- name: Build the docs
run : cmake "-DPROJECT_SOURCE_DIR=$PWD" "-DPROJECT_BINARY_DIR=$PWD/build" -P cmake/docs-ci.cmake
33 changes: 14 additions & 19 deletions .github/workflows/doxygen-gh-pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,37 +7,32 @@ on:

jobs:
deploy:
runs-on: ubuntu-latest
defaults:
run:
shell: bash

runs-on: macos-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
submodules: "true"
- name: Install dependencies - ubuntu
run: |
sudo apt-get update
sudo apt-get install doxygen graphviz -y
sudo apt-get install -y libhdf5-dev libboost-all-dev
git clone https://github.com/catchorg/Catch2.git
cd Catch2
git checkout "v3.5.3"
cmake -Bbuild -H. -DBUILD_TESTING=OFF
sudo cmake --build build/ --target install
shell: bash

- name: Install dependencies - macos
run: brew install hdf5 boost catch2 doxygen graphviz

- name: Configure and build the API
run: |
cmake --preset=ci-ubuntu
cmake --build build
shell: bash
- name: Configure
shell: pwsh
run: cmake "--preset=ci-macos"

- name: Build
run: cmake --build build

- name: Build the docs
run : cmake "-DPROJECT_SOURCE_DIR=$PWD" "-DPROJECT_BINARY_DIR=$PWD/build" -P cmake/docs-ci.cmake
shell: bash

- name: Create .nojekyll to ensure pages with underscores work on gh pages
run: touch build/docs/html/.nojekyll
shell: bash

- name: Deploy to GitHub Pages
uses: JamesIves/github-pages-deploy-action@v4
Expand Down
4 changes: 0 additions & 4 deletions docs/Doxyfile.in
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,6 @@ GENERATE_LATEX = NO
XML_PROGRAMLISTING = NO
CREATE_SUBDIRS = NO

# Include all directories, files and namespaces in the documentation
# Disable to include only explicitly documented objects
M_SHOW_UNDOCUMENTED = YES

# Doxygen Awesome Style settings for sidebar-only layout
GENERATE_TREEVIEW = YES # required!
DISABLE_INDEX = NO
Expand Down
Loading