Set up Quarto website (#37)

Still very minimal, but after this we can start filling it in, and
including the notebooks to the documentation.

Does not yet include the edits to thegoodcloud.md from #36. Probably
that file needs some extra tweaks anyway to make it render nicely.

.github/workflows/docs.yml

@@ -0,0 +1,39 @@
+name: Docs
+on:
+  push:
+    branches: [main]
+    paths-ignore: [".teamcity/**"]
+  pull_request:
+  merge_group:
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+jobs:
+  publish:
+    name: Docs
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: prefix-dev/[email protected]
+        with:
+          pixi-version: "latest"
+      - name: Prepare pixi
+        run: pixi run install-without-pre-commit
+
+      - 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
+        if: github.ref == 'refs/heads/main'
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs/_site
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/python_lint.yml

@@ -19,7 +19,6 @@ jobs:
       - uses: prefix-dev/[email protected]
         with:
           pixi-version: "latest"
-          cache: true
       - name: Prepare pixi
         run: pixi run install-without-pre-commit
       - name: Run mypy on hydamo

.github/workflows/python_tests.yml

@@ -26,7 +26,6 @@ jobs:
       - uses: prefix-dev/[email protected]
         with:
           pixi-version: "latest"
-          cache: true
       - name: Prepare pixi
         run: pixi run install-without-pre-commit
 

docs/.gitignore

@@ -0,0 +1,3 @@
+/.quarto/
+/_site/
+/reference/

docs/_quarto.yml

@@ -0,0 +1,41 @@
+project:
+  type: website
+
+website:
+  title: "Ribasim-NL"
+  navbar:
+    left:
+      - reference/index.qmd
+      - cloudstorage.qmd
+    right:
+      - icon: github
+        href: https://github.com/Deltares/Ribasim-NL
+        aria-label: GitHub
+
+format:
+  html:
+    theme: cosmo
+    css: styles.css
+    toc: true
+
+quartodoc:
+  style: pkgdown
+  dir: reference
+  title: API Reference
+  package: null
+  sections:
+    - title: HyDAMO
+      package: hydamo
+      desc: The HyDAMO class represents the HyDAMO data model.
+      contents:
+        - HyDAMO
+        - ExtendedGeoDataFrame
+        - find_nearest_branch
+        - possibly_intersecting
+        - add_styles_to_geopackage
+        - read_style
+    - title: Ribasim-NL
+      package: ribasim_nl
+      desc: Ribasim-NL code.
+      contents:
+        - CloudStorage

docs/assets/styles.css

@@ -0,0 +1 @@
+/* css styles */

docs/thegoodcloud.md → docs/cloudstorage.qmd

@@ -1,3 +1,7 @@
+---
+title: "Cloud storage"
+---
+
 # Connecting The Good Cloud
 
 ## OS environment variables
@@ -21,6 +25,16 @@ And else
 cloud_storage = CloudStorage(password=password, data_dir=my_data_dir)
 ```
 
+## Download sources (basisgegevens)
+Find all sources
+
+```
+# find all sources, `PBL_watertypenkaart`
+sources = cloud_storage.source_data
+# download, `PBL_watertypenkaart`
+cloud.download_basisgegevens(bronnen=["PBL_watertypenkaart"])
+```
+
 ## Find water authorities
 To find available water authorities:
 ```
@@ -39,3 +53,11 @@ cloud_storage.download_verwerkt(authority)
 
 # to download all
 cloud_storage.download_all(authority)
+```
+
+## Upload manipulated data (aangeleverd)
+```
+authority = "Rijkswaterstaat"
+# upload local `aangeleverd` directory to cloud-storage
+cloud_storage.upload_aangeleverd(authority, overwrite=True)
+```

docs/index.qmd

@@ -0,0 +1,6 @@
+---
+title: "Ribasim-NL"
+---
+
+Ribasim-NL facilitates Ribasim water resources modeling in the Netherlands.
+For more informantion on Ribasim itself please see the [Ribasim documentation](https://deltares.github.io/Ribasim/).