diff --git a/.github/workflows/developer.yml b/.github/workflows/developer.yml index bdb2929b..1bddfd9a 100644 --- a/.github/workflows/developer.yml +++ b/.github/workflows/developer.yml @@ -133,9 +133,6 @@ jobs: path: ~/data key: data-2 - - name: Setup Pages - uses: actions/configure-pages@v4 - - name: build run: | cd wgrib2 @@ -168,6 +165,4 @@ jobs: with: path: wgrib2/build/docs/html # Path to the built site files - - name: Deploy - uses: actions/deploy-pages@v1 diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 00000000..03759b69 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,105 @@ +# This workflow builds the docs and uploads them to gh-pages branch +# for the wgrib2 project. +# +# Ed Hartnett +name: docs +on: + push: + branches: + - develop + +# Cancel in-progress workflows when pushing to a branch +concurrency: + group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }} + cancel-in-progress: true + +jobs: + docs: + runs-on: ubuntu-latest + env: + FC: gfortran + CC: gcc + + permissions: + id-token: write + pages: write + + steps: + + - name: install + run: | + sudo apt-get update + sudo apt-get install libnetcdf-dev libnetcdff-dev netcdf-bin pkg-config + sudo apt-get install libpng-dev autotools-dev libaec-dev autoconf gcovr doxygen + + - name: cache-jasper + id: cache-jasper + uses: actions/cache@v4 + with: + path: ~/jasper + key: jasper-${{ runner.os }}-1.900.1 + + - name: checkout-jasper + if: steps.cache-jasper.outputs.cache-hit != 'true' + uses: actions/checkout@v4 + with: + repository: jasper-software/jasper + path: jasper + ref: version-1.900.1 + + - name: build-jasper + if: steps.cache-jasper.outputs.cache-hit != 'true' + run: | + cd jasper + ./configure --prefix=$HOME/Jasper + make + make install + + - name: checkout-ip + uses: actions/checkout@v4 + with: + repository: NOAA-EMC/NCEPLIBS-ip + path: ip + ref: v5.0.0 + + - name: build-ip + run: | + cd ip + mkdir build + cd build + cmake .. -DCMAKE_INSTALL_PREFIX=~/ip + make -j2 + make install + + - name: checkout + uses: actions/checkout@v4 + with: + path: wgrib2 + + - name: cache-data + id: cache-data + uses: actions/cache@v4 + with: + path: ~/data + key: data-2 + + - name: Setup Pages + uses: actions/configure-pages@v4 + + - name: build + run: | + cd wgrib2 + mkdir build + cd build + cmake .. -DENABLE_DOCS=ON -DCMAKE_PREFIX_PATH="~/ip" + make VERBOSE=1 + + - name: Upload built documentation + uses: actions/upload-pages-artifact@v1 + with: + path: wgrib2/build/docs/html # Path to the built site files + + - name: Deploy + uses: actions/deploy-pages@v1 + + diff --git a/docs/user_guide.md b/docs/user_guide.md index c88d4a74..5e93bb56 100644 --- a/docs/user_guide.md +++ b/docs/user_guide.md @@ -2,7 +2,8 @@ # Introduction -This document briefly describes wgrib2. +This document briefly describes wgrib2, which provides functionality +for interacting with, reading, writing, and manipulating GRIB2 files. ## Documentation for Previous Versions of wgrib2