Skip to content

Commit

Permalink
turn on doxygen build in CI (#932)
Browse files Browse the repository at this point in the history
* turn on doxygen build in CI

* turn on doxygen build in CI

* turn on doxygen build in CI

* turn on doxygen build in CI

* fixed cmake file

* fixed doc directory
  • Loading branch information
edwardhartnett committed Apr 22, 2024
1 parent 5d6d179 commit 79d74d9
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 6 deletions.
5 changes: 3 additions & 2 deletions .github/workflows/gcc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ defaults:
shell: bash -leo pipefail {0}

env:
cache_key: gcc2 # The number (#) following the cache_key "gcc" is to flush Action cache.
cache_key: gcc3 # The number (#) following the cache_key "gcc" is to flush Action cache.
CC: gcc-10
FC: gfortran-10
CXX: g++-10
Expand Down Expand Up @@ -60,6 +60,7 @@ jobs:
sudo apt install cmake
spack external find
spack add mpich@3.4.2
spack add doxygen
spack concretize
spack install -v --fail-fast --dirty
spack clean --all
Expand Down Expand Up @@ -91,6 +92,6 @@ jobs:
export FC=mpif90
cd UPP
mkdir -p build && cd build
cmake -DCMAKE_INSTALL_PREFIX=../install ..
cmake -DENABLE_DOCS=ON -DCMAKE_INSTALL_PREFIX=../install ..
make -j2 VERBOSE=1
make install
2 changes: 1 addition & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ add_subdirectory(parm)
# If desired, build the doxygen docs.
if(ENABLE_DOCS)
find_package(Doxygen REQUIRED)
add_subdirectory(docs)
add_subdirectory(doc)
endif()

### Package config
Expand Down
6 changes: 3 additions & 3 deletions doc/Doxyfile.in
Original file line number Diff line number Diff line change
Expand Up @@ -846,8 +846,8 @@ WARN_LOGFILE =
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.

INPUT = @abs_top_srcdir@/docs/user_guide.md \
= @abs_top_srcdir@/docs/2D-decomp.md \
INPUT = @abs_top_srcdir@/doc/user_guide.md \
= @abs_top_srcdir@/doc/2D-decomp.md \
@abs_top_srcdir@/sorc/ncep_post.fd \
@config_srcdir@

Expand Down Expand Up @@ -1007,7 +1007,7 @@ FILTER_SOURCE_PATTERNS =
# (index.html). This can be useful if you have a project on for instance GitHub
# and want to reuse the introduction page also for the doxygen output.

USE_MDFILE_AS_MAINPAGE = @abs_top_srcdir@/docs/sp_user_guide.md
USE_MDFILE_AS_MAINPAGE = @abs_top_srcdir@/doc/user_guide.md

# By default, all characters from position 72 are to be considered as comment.
# This prevents Doxygen from recognizing certain variables as undocumented
Expand Down

0 comments on commit 79d74d9

Please sign in to comment.