diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index d3645bfe4..97ea5d3b6 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -52,7 +52,10 @@ jobs: - name: Generate API pages working-directory: docs - run: python -m quartodoc build + # objects.json: https://github.com/machow/quartodoc/issues/63 + run: | + python -m quartodoc build + rm objects.json - name: Render Quarto Project run: "quarto render docs --to html --execute" diff --git a/docs/.gitignore b/docs/.gitignore index a6c026b68..523c19ba3 100644 --- a/docs/.gitignore +++ b/docs/.gitignore @@ -2,4 +2,3 @@ /_site/ /docs/python/reference/ *.html -/objects.json diff --git a/docs/_quarto.yml b/docs/_quarto.yml index c667d8443..06a98249c 100644 --- a/docs/_quarto.yml +++ b/docs/_quarto.yml @@ -1,22 +1,40 @@ project: type: website - resources: - - objects.json website: title: "Ribasim" + page-navigation: true navbar: + logo: https://user-images.githubusercontent.com/4471859/224825908-bee7e044-bc6b-4561-8b08-5d330cce3ed5.png left: - - equations.qmd - - modflow.qmd - - coupling-demo.qmd - - developer.qmd - - python/index.qmd + - text: "Equations" + file: equations.qmd + - text: "Modflow" + file: modflow.qmd + - text: "Coupling" + file: coupling-demo.qmd + - text: "Developer" + file: developer.qmd + - text: "Python" + file: python/index.qmd + right: + - icon: github + href: https://github.com/Deltares/Ribasim + aria-label: GitHub + + sidebar: + - title: "Python" + contents: + - python/index.qmd + - python/examples.ipynb + - python/reference/index.qmd + - title: "To be continued" + contents: [] format: html: theme: cosmo - css: styles.css + css: assets/styles.css toc: true bibliography: references.bib diff --git a/docs/styles.css b/docs/assets/styles.css similarity index 100% rename from docs/styles.css rename to docs/assets/styles.css diff --git a/docs/python/index.qmd b/docs/python/index.qmd index 6ee16f761..70b03332c 100644 --- a/docs/python/index.qmd +++ b/docs/python/index.qmd @@ -12,8 +12,5 @@ Python instead. One can also use Ribasim Python to build entire models from base data, such that your model setup is fully reproducible. -- [Examples](examples.ipynb) -- [API reference](reference/) - The package is [registered in PyPI](https://pypi.org/project/ribasim/) and can therefore be installed with `pip install ribasim`.