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

Doxygen #62

Merged
merged 2 commits into from
Oct 21, 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
49 changes: 49 additions & 0 deletions .github/workflows/ci_doxygen.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
name: Build Documentation
on:
workflow_dispatch:
push:
branches:
- 'master'
jobs:
ci_doxygen:
if: ${{github.ref_name}} == 'master'
runs-on: ubuntu-latest
steps:
- name: Clone Repo
shell: bash
working-directory: ${{runner.workspace}}
run: |
git clone https://github.com/ORNL-Fusion/Stellarator-Tools.git ${{runner.workspace}}/Stellarator-Tools
git clone https://token:${{secrets.AUTH_TOKEN}}@github.com/ORNL-Fusion/Stellarator-Tools-Docs.git
- name: Create build directory.
shell: bash
working-directory: ${{runner.workspace}}/Stellarator-Tools
run: cmake -E make_directory build
- name: Install Libraries Linux
shell: bash
run: |
sudo apt update
sudo apt-get install libnetcdf-dev
sudo apt-get install libnetcdff-dev
sudo apt-get install libopenmpi-dev
sudo apt-get install libscalapack-openmpi-dev
sudo apt-get install doxygen
- name: Configure CMake
shell: bash
working-directory: ${{runner.workspace}}/Stellarator-Tools/build
run: cmake -DBUILD_BOOZ_XFORM=ON -DBUILD_V3FIT=ON -DBUILD_V3RFUN=ON -DBUILD_SIESTA=ON -DBUILD_LGRID=ON -DBUILD_SURFACE=ON -DBUILD_BMW=ON -DBUILD_PARVMEC=ON -DBUILD_DESCUR=ON -DDOXYGEN_OUTPUT_DIRECTORY=${{runner.workspace}}/Stellarator-Tools-Docs -DDOXYGEN_HTML_OUTPUT=docs ../
- name: Build
shell: bash
working-directory: ${{runner.workspace}}/Stellarator-Tools/build
run: make doc
- name: Push changes.
shell: bash
working-directory: ${{runner.workspace}}/Stellarator-Tools-Docs/docs
env:
GITHUB_TOKEN: ${{secrets.AUTH_TOKEN}}
run: |
git config user.name ${{secrets.AUTH_USER}}
git config user.email ${{secrets.AUTH_EMAIL}}
git add *
git commit . -m "Update Doxygen docs."
git push origin main
6 changes: 3 additions & 3 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,9 @@ target_link_libraries (stell
$<$<AND:$<BOOL:${LAPACK_FOUND}>,$<VERSION_GREATER_EQUAL:${CMAKE_VERSION},3.18>>:LAPACK::LAPACK>
$<$<AND:$<BOOL:${BLAS_FOUND}>,$<VERSION_LESS:${CMAKE_VERSION},3.18>>:${BLAS_LIBRARIES}>
$<$<AND:$<BOOL:${LAPACK_FOUND}>,$<VERSION_LESS:${CMAKE_VERSION},3.18>>:${LAPACK_LIBRARIES}>
# sanitizer
# traps
# checks
sanitizer
traps
checks
)
target_include_directories (stell

Expand Down