From 4f78d3d35a0f944dae9a38e95deff1e78c755cc5 Mon Sep 17 00:00:00 2001 From: Martijn Visser Date: Thu, 13 Jun 2024 16:36:01 +0200 Subject: [PATCH] Quarto PDF docs take 2 --- docs/_quarto-manual.yml | 44 ++++++++++++++++ docs/_quarto-website.yml | 104 +++++++++++++++++++++++++++++++++++++ docs/_quarto.yml | 107 ++------------------------------------- 3 files changed, 151 insertions(+), 104 deletions(-) create mode 100644 docs/_quarto-manual.yml create mode 100644 docs/_quarto-website.yml diff --git a/docs/_quarto-manual.yml b/docs/_quarto-manual.yml new file mode 100644 index 000000000..0bbf51448 --- /dev/null +++ b/docs/_quarto-manual.yml @@ -0,0 +1,44 @@ +project: + type: book + +book: + title: "Ribasim documentation" + chapters: + - part: index.qmd + - part: tutorial/index.qmd + chapters: + - tutorial/qgis.qmd + - part: guide/index.qmd + chapters: + - guide/examples.ipynb + - guide/coupling.qmd + - part: concept/index.qmd + chapters: + - concept/concept.qmd + - concept/modelconcept.qmd + - concept/equations.qmd + - concept/numerics.qmd + - concept/core.qmd + - concept/allocation.qmd + - part: reference/index.qmd + chapters: + - reference/index.qmd + - reference/usage.qmd + - reference/validation.qmd + - reference/test-models.qmd + - reference/python/index.qmd + - reference/node/basin.qmd + - reference/node/tabulated-rating-curve.qmd + - reference/node/pump.qmd + - reference/node/outlet.qmd + - reference/node/user-demand.qmd + - reference/node/flow-demand.qmd + - reference/node/level-demand.qmd + - reference/node/flow-boundary.qmd + - reference/node/level-boundary.qmd + - reference/node/linear-resistance.qmd + - reference/node/manning-resistance.qmd + - reference/node/fractional-flow.qmd + - reference/node/terminal.qmd + - reference/node/discrete-control.qmd + - reference/node/pid-control.qmd diff --git a/docs/_quarto-website.yml b/docs/_quarto-website.yml new file mode 100644 index 000000000..35553b6ad --- /dev/null +++ b/docs/_quarto-website.yml @@ -0,0 +1,104 @@ +project: + type: website + resources: + - schema/*.schema.json + +website: + title: "Ribasim" + page-navigation: true + navbar: + logo: https://user-images.githubusercontent.com/4471859/224825908-bee7e044-bc6b-4561-8b08-5d330cce3ed5.png + left: + - text: "Overview" + file: index.qmd + - text: "Tutorials" + file: tutorial/index.qmd + - text: "How-to guides" + file: guide/index.qmd + - text: "Concepts" + file: concept/index.qmd + - text: "Reference" + file: reference/index.qmd + right: + - text: "Contributing" + file: dev/index.qmd + - icon: github + href: https://github.com/Deltares/Ribasim + aria-label: GitHub + + sidebar: + - title: "Overview" + contents: + - index.qmd + - install.qmd + - changelog.qmd + + - title: "Tutorials" + contents: + - tutorial/index.qmd + - tutorial/qgis.qmd + + - title: "How-to guides" + contents: + - guide/index.qmd + - guide/examples.ipynb + - guide/coupling.qmd + + - title: "Concepts" + contents: + - concept/index.qmd + - concept/concept.qmd + - section: "Numerics" + contents: + - concept/modelconcept.qmd + - concept/equations.qmd + - concept/numerics.qmd + - section: "Implementation" + contents: + - concept/core.qmd + - concept/allocation.qmd + + - title: "Reference" + contents: + - reference/index.qmd + - reference/usage.qmd + - reference/validation.qmd + - reference/test-models.qmd + - reference/python/index.qmd + - section: "Nodes" + contents: + - reference/node/basin.qmd + - reference/node/tabulated-rating-curve.qmd + - reference/node/pump.qmd + - reference/node/outlet.qmd + - reference/node/user-demand.qmd + - reference/node/flow-demand.qmd + - reference/node/level-demand.qmd + - reference/node/flow-boundary.qmd + - reference/node/level-boundary.qmd + - reference/node/linear-resistance.qmd + - reference/node/manning-resistance.qmd + - reference/node/fractional-flow.qmd + - reference/node/terminal.qmd + - reference/node/discrete-control.qmd + - reference/node/pid-control.qmd + + - title: "Dev docs" + contents: + - dev/index.qmd + - dev/core.qmd + - dev/addnode.qmd + - dev/python.qmd + - dev/qgis.qmd + - dev/bmi.qmd + - dev/ci.qmd + - dev/release.qmd + +format: + html: + theme: cosmo + css: assets/styles.css + toc: true + +bibliography: references.bib +number-sections: true diff --git a/docs/_quarto.yml b/docs/_quarto.yml index ca87c7865..b0339d668 100644 --- a/docs/_quarto.yml +++ b/docs/_quarto.yml @@ -1,107 +1,6 @@ -project: - type: website - resources: - - schema/*.schema.json - -website: - title: "Ribasim" - page-navigation: true - navbar: - logo: https://user-images.githubusercontent.com/4471859/224825908-bee7e044-bc6b-4561-8b08-5d330cce3ed5.png - left: - - text: "Overview" - file: index.qmd - - text: "Tutorials" - file: tutorial/index.qmd - - text: "How-to guides" - file: guide/index.qmd - - text: "Concepts" - file: concept/index.qmd - - text: "Reference" - file: reference/index.qmd - right: - - text: "Contributing" - file: dev/index.qmd - - icon: github - href: https://github.com/Deltares/Ribasim - aria-label: GitHub - - sidebar: - - title: "Overview" - contents: - - index.qmd - - install.qmd - - changelog.qmd - - - title: "Tutorials" - contents: - - tutorial/index.qmd - - tutorial/qgis.qmd - - - title: "How-to guides" - contents: - - guide/index.qmd - - guide/examples.ipynb - - guide/coupling.qmd - - - title: "Concepts" - contents: - - concept/index.qmd - - concept/concept.qmd - - section: "Numerics" - contents: - - concept/modelconcept.qmd - - concept/equations.qmd - - concept/numerics.qmd - - section: "Implementation" - contents: - - concept/core.qmd - - concept/allocation.qmd - - - title: "Reference" - contents: - - reference/index.qmd - - reference/usage.qmd - - reference/validation.qmd - - reference/python/index.qmd - - reference/test-models.qmd - - section: "Nodes" - contents: - - reference/node/basin.qmd - - reference/node/tabulated-rating-curve.qmd - - reference/node/pump.qmd - - reference/node/outlet.qmd - - reference/node/user-demand.qmd - - reference/node/flow-demand.qmd - - reference/node/level-demand.qmd - - reference/node/flow-boundary.qmd - - reference/node/level-boundary.qmd - - reference/node/linear-resistance.qmd - - reference/node/manning-resistance.qmd - - reference/node/fractional-flow.qmd - - reference/node/terminal.qmd - - reference/node/discrete-control.qmd - - reference/node/pid-control.qmd - - - title: "Dev docs" - contents: - - dev/index.qmd - - dev/core.qmd - - dev/addnode.qmd - - dev/python.qmd - - dev/qgis.qmd - - dev/bmi.qmd - - dev/ci.qmd - - dev/release.qmd - -format: - html: - theme: cosmo - css: assets/styles.css - toc: true - -bibliography: references.bib -number-sections: true +profile: + group: + - [website, manual] quartodoc: style: pkgdown