add ribasim-python to docs (#103)

Still a draft, since I still need to update
[docs.yml](https://github.com/Deltares/Ribasim/blob/main/.github/workflows/docs.yml).
This uses [quartodoc](https://github.com/machow/quartodoc/) for the API
reference, and the
[include-code-files](https://github.com/quarto-ext/include-code-files)
Quarto extension directly include the example Python scripts into the
docs.

Some screenshots:


![image](https://user-images.githubusercontent.com/4471859/224362710-f5ce9ac3-b3ef-4ffc-8c3e-ba3ebd6789f3.png)

![image](https://user-images.githubusercontent.com/4471859/224362776-2bc587c5-6a2f-4b98-9880-57ecad21843b.png)

![image](https://user-images.githubusercontent.com/4471859/224363012-5f08b4c1-6328-4a7d-9bc8-26d45c50bd5e.png)

![image](https://user-images.githubusercontent.com/4471859/224363204-515316c2-cb94-4014-8d60-3049d20fbf2e.png)

.github/workflows/CI.yml

@@ -43,8 +43,6 @@ jobs:
       - uses: julia-actions/julia-buildpkg@v1
         with:
           project: core
-        env:
-          JULIA_PKG_SERVER: "pkg.julialang.org"
       - uses: julia-actions/julia-runtest@v1
         with:
           project: core

.github/workflows/docs.yml

@@ -22,8 +22,8 @@ jobs:
           version: ${{ matrix.version }}
           arch: ${{ matrix.arch }}
       - uses: julia-actions/julia-buildpkg@v1
-        env:
-          JULIA_PKG_SERVER: "pkg.julialang.org"
+        with:
+          project: core
       - uses: actions/cache@v1
         env:
           cache-name: cache-artifacts
@@ -38,22 +38,24 @@ jobs:
       - uses: actions/setup-python@v4
         with:
           python-version: '3.11'
-      - run: pip install jupyter
+      - run: pip install jupyter quartodoc xarray
 
-      - name: Install IJulia
-        run: julia -e 'using Pkg; Pkg.add("IJulia")'
+      - name: Install ribasim-python
+        working-directory: python
+        run: pip install -e .
 
       - name: Set up Quarto
         uses: quarto-dev/quarto-actions/setup@v2
 
-      - name: Check Quarto install
-        run: quarto check install
+      - name: Check Quarto installation and all engines
+        run: quarto check all
 
-      - name: Check Quarto kernels
-        run: quarto check jupyter
+      - name: Generate API pages
+        working-directory: docs
+        run: python -m quartodoc build
 
       - name: Render Quarto Project
-        run: "quarto render docs --to html"  # TODO add --execute back
+        run: "quarto render docs --to html --execute"
 
       - name: Publish Quarto Project
         if: github.event_name != 'pull_request'

.gitignore

@@ -16,8 +16,8 @@ docs/site/
 /core/Manifest.toml
 
 /data/
-compile/create_binaries/ribasim_cli/
-compile/create_binaries/libribasim/
+build/create_binaries/ribasim_cli/
+build/create_binaries/libribasim/
 
 .vscode
 JuliaSysimage.dll
@@ -153,12 +153,5 @@ dmypy.json
 # Pyre type checker
 .pyre/
 
-# Generated docs
-/docs
-
 # VS Code settings
 *.vscode
-
-# Example models
-/examples/basic
-/examples/basic-transient

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Deltares
+Copyright (c) Ribasim developers
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

core/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Deltares
+Copyright (c) Ribasim developers
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

docs/.gitignore

@@ -1,3 +1,5 @@
 /.quarto/
 /_site/
-/site_libs/
+/docs/python/reference/
+*.html
+/objects.json