From 91bb025a84ff0033ac75392878c3e4146483910c Mon Sep 17 00:00:00 2001 From: Edward Hartnett Date: Thu, 18 Apr 2024 10:00:08 -0600 Subject: [PATCH 1/6] turn on doxygen build in CI --- .github/workflows/gcc.yml | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/.github/workflows/gcc.yml b/.github/workflows/gcc.yml index af627a375..8fb831ac6 100644 --- a/.github/workflows/gcc.yml +++ b/.github/workflows/gcc.yml @@ -39,6 +39,10 @@ jobs: with: path: UPP + - name: install-dependencies + run: | + sudo apt-get install doxygen + # Cache spack, compiler and dependencies - name: cache-env id: cache-env @@ -91,6 +95,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 From 853f480970d29efaf38e6ae28c64c207bf767358 Mon Sep 17 00:00:00 2001 From: Edward Hartnett Date: Thu, 18 Apr 2024 10:05:39 -0600 Subject: [PATCH 2/6] turn on doxygen build in CI --- .github/workflows/gcc.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/gcc.yml b/.github/workflows/gcc.yml index 8fb831ac6..784ff99bf 100644 --- a/.github/workflows/gcc.yml +++ b/.github/workflows/gcc.yml @@ -39,9 +39,9 @@ jobs: with: path: UPP - - name: install-dependencies - run: | - sudo apt-get install doxygen + - name: install-dependencies-with-apt-get + run: | + sudo apt-get install doxygen # Cache spack, compiler and dependencies - name: cache-env From 8d3f73a9fabeaf284b95d53b829b2377a232287f Mon Sep 17 00:00:00 2001 From: Edward Hartnett Date: Thu, 18 Apr 2024 10:09:04 -0600 Subject: [PATCH 3/6] turn on doxygen build in CI --- .github/workflows/gcc.yml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/gcc.yml b/.github/workflows/gcc.yml index 784ff99bf..cbd6aeac4 100644 --- a/.github/workflows/gcc.yml +++ b/.github/workflows/gcc.yml @@ -39,10 +39,6 @@ jobs: with: path: UPP - - name: install-dependencies-with-apt-get - run: | - sudo apt-get install doxygen - # Cache spack, compiler and dependencies - name: cache-env id: cache-env @@ -72,6 +68,10 @@ jobs: needs: setup runs-on: ubuntu-latest + - name: install-dependencies-with-apt-get + run: | + sudo apt-get install doxygen + steps: - name: checkout-upp uses: actions/checkout@v2 From 2bda6359b1e7ae3dd2b17562f553973dbfd58f61 Mon Sep 17 00:00:00 2001 From: Edward Hartnett Date: Thu, 18 Apr 2024 10:11:22 -0600 Subject: [PATCH 4/6] turn on doxygen build in CI --- .github/workflows/gcc.yml | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/.github/workflows/gcc.yml b/.github/workflows/gcc.yml index cbd6aeac4..74b981bf0 100644 --- a/.github/workflows/gcc.yml +++ b/.github/workflows/gcc.yml @@ -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 @@ -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 @@ -68,10 +69,6 @@ jobs: needs: setup runs-on: ubuntu-latest - - name: install-dependencies-with-apt-get - run: | - sudo apt-get install doxygen - steps: - name: checkout-upp uses: actions/checkout@v2 From 8c41b0101b8367c68650152f9f8a4b24c2cf1872 Mon Sep 17 00:00:00 2001 From: Edward Hartnett Date: Thu, 18 Apr 2024 10:55:13 -0600 Subject: [PATCH 5/6] fixed cmake file --- CMakeLists.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index dd59b532b..6be176fba 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -119,7 +119,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 From 799943a380e85e0c1dd3553e5f945c8bd06dc967 Mon Sep 17 00:00:00 2001 From: Edward Hartnett Date: Thu, 18 Apr 2024 11:00:04 -0600 Subject: [PATCH 6/6] fixed doc directory --- doc/Doxyfile.in | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index e139a1142..c0609df47 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -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@ @@ -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