Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add docs #18

Closed
visr opened this issue Oct 9, 2023 · 1 comment
Closed

add docs #18

visr opened this issue Oct 9, 2023 · 1 comment

Comments

@visr
Copy link
Member

visr commented Oct 9, 2023

I plan to use Quarto, similar to https://github.com/Deltares/Ribasim. With this we can easily include notebooks into our documentation as well. Some points for our developer docs:

          Some things noticed:
  • Win-users (expect the majority in our community) need to use powershell in the pixi install instructions: https://deltares.github.io/Ribasim/contribute/python.html#setting-up-pixi. Something Google tells you immediately, but nevertheless most will default try in CMD and fail.
  • pixi run install is something we need to add in the docs
  • pixi run python is something we need to add in the docs as well

Other than that, works like a charm!

Originally posted by @d2hydro in #17 (review)

@visr visr mentioned this issue Oct 10, 2023
3 tasks
@visr
Copy link
Member Author

visr commented Oct 10, 2023

Closed as a duplicate of #13

@visr visr closed this as not planned Won't fix, can't repro, duplicate, stale Oct 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant