Documentation: Add h5dump
to developer tools
#307
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Documentation | |
on: | |
- push | |
jobs: | |
build: | |
name: 📘 Build Documentation | |
# Building the documentation on macOS is currently faster than on Linux, | |
# since on Linux some of the R packages are installed from source. | |
runs-on: macos-latest | |
steps: | |
- name: Checkout repository | |
uses: actions/checkout@v4 | |
with: | |
submodules: true | |
- name: Install R | |
uses: r-lib/actions/setup-r@v2 | |
- name: Install Pandoc | |
uses: r-lib/actions/setup-pandoc@v2 | |
- name: Install TinyTeX | |
uses: r-lib/actions/setup-tinytex@v2 | |
- name: Install bookdown | |
run: Rscript -e "install.packages(c('rmarkdown', 'bookdown'))" | |
- name: Build documentation | |
run: | | |
! make doc 2>&1 >/dev/null | grep 'Warning: LaTeX Warning' | |
- name: Upload documentation | |
uses: actions/upload-artifact@v4 | |
with: | |
name: ICOc Manual | |
path: Bookdown | |
deploy-pages: | |
name: 🌐 Upload documentation to GitHub Pages | |
runs-on: ubuntu-latest | |
needs: build | |
steps: | |
- name: Download bookdown documentation | |
uses: actions/download-artifact@v4 | |
with: | |
name: ICOc Manual | |
path: Bookdown | |
- name: Deploy | |
uses: peaceiris/actions-gh-pages@v3 | |
with: | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
publish_dir: Bookdown |