Skip to content

Commit

Permalink
Deploy docs with CI
Browse files Browse the repository at this point in the history
Fixes #31
  • Loading branch information
Hofer-Julian committed Jan 20, 2023
1 parent a61bfd9 commit 605e56b
Show file tree
Hide file tree
Showing 15 changed files with 5,605 additions and 45 deletions.
61 changes: 61 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
name: docs
on:
push:
branches: [main]
pull_request:
jobs:
publish:
name: Julia ${{ matrix.version }} - ${{ matrix.arch }} - ${{ github.event_name }}
runs-on: ubuntu-latest
permissions:
contents: write
strategy:
matrix:
version:
- "1.8" # make sure to keep this in sync with _quarto.yml
arch:
- x64
steps:
- uses: actions/checkout@v2
- uses: julia-actions/setup-julia@v1
with:
version: ${{ matrix.version }}
arch: ${{ matrix.arch }}
- uses: julia-actions/julia-buildpkg@v1
- uses: actions/cache@v1
env:
cache-name: cache-artifacts
with:
path: ~/.julia/artifacts
key: ${{ runner.os }}-test-${{ env.cache-name }}-${{ hashFiles('**/Project.toml') }}
restore-keys: |
${{ runner.os }}-test-${{ env.cache-name }}-
${{ runner.os }}-test-
# setup Python / Jupyter
- uses: actions/setup-python@v4
with:
python-version: '3.x'
- run: pip install jupyter

- name: Install IJulia
run: julia -e 'using Pkg; Pkg.add("IJulia")'

- name: Set up Quarto
uses: quarto-dev/quarto-actions/setup@v2

- name: Check Quarto kernels
run: quarto check jupyter

- name: Render Quarto Project
run: "quarto render docs --to html --execute"

- name: Publish Quarto Project
if: github.event_name != 'pull_request'
uses: quarto-dev/quarto-actions/publish@v2
with:
path: docs
render: false
target: gh-pages
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
7 changes: 4 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,12 @@ docs/site/
# It records a fixed state of all packages used by the project. As such, it should not be
# committed for packages, but should be committed for applications that require a static
# environment.
Manifest.toml
/Manifest.toml

data/
/data/
compile/ribasim_cli/create_app/ribasim_cli/
compile/libribasim/create_lib/libribasim/

.vscode
JuliaSysimage.dll
JuliaSysimage.dll
.ipynb_checkpoints
Loading

0 comments on commit 605e56b

Please sign in to comment.