Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move docs to quarto for v1 #448

Merged
merged 30 commits into from
Nov 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
d5c4e39
update docs to quarto
JoostBuitink Aug 15, 2024
ba3c384
add quarto tasks to pixi
JoostBuitink Aug 15, 2024
b2ae786
github action
JoostBuitink Aug 15, 2024
991f8e8
Update pixi.toml
JoostBuitink Aug 15, 2024
2742761
install quarto
JoostBuitink Aug 15, 2024
2667586
add version to quarto install
JoostBuitink Aug 15, 2024
edf50c3
remove notebook
JoostBuitink Aug 15, 2024
609acaf
format fixes
JoostBuitink Aug 15, 2024
c3fdf24
Merge branch 'docs_nitpicks' into v1_quarto_docs
SouthEndMusic Oct 28, 2024
1117b5f
Reintroduce custom LaTeX macros
SouthEndMusic Oct 28, 2024
1a79f04
Fixes
SouthEndMusic Oct 28, 2024
4abd0cb
Create plot with Julia in quarto docs
SouthEndMusic Oct 29, 2024
913c818
Update quarto-render task
SouthEndMusic Oct 29, 2024
496d90c
Add prerequisites for automatic table generation
SouthEndMusic Oct 29, 2024
9135395
rewrap text
JoostBuitink Oct 30, 2024
16f2be5
fix `@ref`
JoostBuitink Oct 30, 2024
8e1673c
fix nav-buttons
JoostBuitink Oct 30, 2024
243f7bd
improve dark colors
JoostBuitink Oct 30, 2024
9646d77
Update install.qmd
JoostBuitink Oct 30, 2024
c6cf086
Update waterbodies.qmd
JoostBuitink Oct 30, 2024
0676a72
update logo
JoostBuitink Oct 31, 2024
83b91a2
Merge branch 'master' into v1_quarto_docs
JoostBuitink Nov 11, 2024
640e7e0
undo pixi.lock changes
JoostBuitink Nov 11, 2024
d15a127
fix sbm_gwf_model
JoostBuitink Nov 11, 2024
81c60b5
Update sbm_gwf_model.jl
JoostBuitink Nov 11, 2024
2c329ab
Merge branch 'master' into v1_quarto_docs
JoostBuitink Nov 12, 2024
cd00d94
update url
JoostBuitink Nov 12, 2024
d6a442a
fix version_switcher
JoostBuitink Nov 13, 2024
300a864
update github actions
JoostBuitink Nov 13, 2024
1766872
add workflow for releases
JoostBuitink Nov 13, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 0 additions & 18 deletions .github/workflows/Documenter.yml

This file was deleted.

72 changes: 72 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
name: Quarto documentation
on:
push:
branches: [master]
tags: [v*]
pull_request:

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true

# needed to allow julia-actions/cache to delete old caches that it has created
permissions:
actions: write
contents: read

jobs:
publish:
name: Build and publish docs
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- uses: actions/checkout@v4
- uses: julia-actions/cache@v2
with:
cache-compiled: "true"
cache-registries: "true"
- uses: prefix-dev/[email protected]
with:
pixi-version: "latest"
- name: Prepare pixi
run: pixi run install-ci

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

- name: Check Quarto installation and all engines
run: pixi run quarto-check

- name: Render Quarto Project
run: pixi run quarto-render

- name: Publish Quarto Project as preview
if: github.event_name == 'pull_request'
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/_site
destination_dir: previews/PR${{ github.event.number }}
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- name: Publish Quarto Project as dev
if: github.event_name == 'push' && github.ref == 'refs/heads/master'
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/_site
destination_dir: dev
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- name: Publish Quarto Project as version
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v')
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/_site
destination_dir: ${{ github.ref_name }}
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
5 changes: 5 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
/.quarto/
/_extensions/
/_freeze/
/_inv/
/_site/
Empty file added docs/.nojekyll
Empty file.
7 changes: 7 additions & 0 deletions docs/404.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: Page Not Found
---

The page you requested cannot be found (perhaps it was moved or renamed).

You may want to try searching to find the page's new location.
Loading