Skip to content

Commit 237c259

Browse files
authored
Convert docs from ipynb to qmd (#2376)
Needed for #2078, since that doesn't work on notebooks directly. Taking this as an intermediate step to avoid getting to many conflicts. Even if we don't make the switch, I think it is better to have all of our docs in the same format. QMD support seems a bit more first class and transparent when working in a repository. I ran this locally and verified that the converted pages still look the same.
1 parent b3c8db3 commit 237c259

15 files changed

+2449
-4024
lines changed

docs/_quarto.yml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ website:
1111
- text: "Overview"
1212
file: index.qmd
1313
- text: "Tutorials"
14-
file: tutorial/natural-flow.ipynb
14+
file: tutorial/natural-flow.qmd
1515
- text: "How-to guides"
16-
file: guide/examples.ipynb
16+
file: guide/examples.qmd
1717
- text: "Concepts"
1818
file: concept/concept.qmd
1919
- text: "Reference"
@@ -34,17 +34,17 @@ website:
3434
- contact.qmd
3535
- title: "Tutorials"
3636
contents:
37-
- tutorial/natural-flow.ipynb
38-
- tutorial/irrigation-demand.ipynb
39-
- tutorial/reservoir.ipynb
37+
- tutorial/natural-flow.qmd
38+
- tutorial/irrigation-demand.qmd
39+
- tutorial/reservoir.qmd
4040
- title: "How-to guides"
4141
contents:
42-
- guide/examples.ipynb
42+
- guide/examples.qmd
4343
- guide/qgis.qmd
4444
- guide/coupling.qmd
4545
- section: "Coupling guides"
4646
contents:
47-
- guide/delwaq.ipynb
47+
- guide/delwaq.qmd
4848
- guide/debug.qmd
4949
- title: "Concepts"
5050
contents:

docs/concept/allocation.qmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,7 @@ $$
233233
234234
## Example
235235
236-
The following is an example of an optimization problem for the example shown [here](/guide/examples.ipynb#model-with-allocation-user-demand):
236+
The following is an example of an optimization problem for the example shown [here](/guide/examples.qmd#model-with-allocation-user-demand):
237237
238238
239239
```{julia}

docs/dev/addnode.qmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -212,7 +212,7 @@ There are several parts of the documentation which should be updated with the ne
212212
- If the node has a rol in the physical layer, `docs/core/equations` should contain a short explanation and if possible an analytical expression for the behavior of the new node;
213213
- If the node has a role in allocation, `docs/core/allocation` should make this role clear;
214214
- `docs/reference/node/new-node-type.qmd` should contain a short explanation of the node and the possible schemas associated with it;
215-
- The example models constructed in `docs/guide/examples.ipynb` should be extended with the new node type or a new example model with the new node type should be made.
215+
- The example models constructed in `docs/guide/examples.qmd` should be extended with the new node type or a new example model with the new node type should be made.
216216
- In `_quarto.yml` add `NewNodeType` to the "Node types" contents for the Python API reference.
217217

218218

docs/guide/coupling.qmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,4 @@ flowchart LR
1919

2020
Delwaq can calculate the concentration of substances in [Basin](/reference/node/basin.qmd) nodes over time, based on initial concentrations, and of [FlowBoundary](/reference/node/flow-boundary.qmd) nodes. Ribasim exposes the `Basin / concentration`, `Basin / concentration_state`, `FlowBoundary / concentration`, and `LevelBoundary / concentration` tables to setup these substances and concentrations.
2121

22-
When a Ribasim model ran with the above tables, one can use the utilities in the `delwaq` namespace of the Ribasim Python API to generate the input required for Delwaq to run, as well as to parse the output from Delwaq into a Ribasim compatible format. For more information see the [guide](/guide/delwaq.ipynb).
22+
When a Ribasim model ran with the above tables, one can use the utilities in the `delwaq` namespace of the Ribasim Python API to generate the input required for Delwaq to run, as well as to parse the output from Delwaq into a Ribasim compatible format. For more information see the [guide](/guide/delwaq.qmd).

docs/guide/delwaq.ipynb

Lines changed: 0 additions & 326 deletions
This file was deleted.

0 commit comments

Comments
 (0)