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

Further improve documentation with examples/tutorials and move to Quarto #224

Closed
JoostBuitink opened this issue Oct 31, 2022 · 4 comments · Fixed by #448
Closed

Further improve documentation with examples/tutorials and move to Quarto #224

JoostBuitink opened this issue Oct 31, 2022 · 4 comments · Fixed by #448
Assignees
Labels
documentation Improvements or additions to documentation v1.0 Activities related to v1.0
Milestone

Comments

@JoostBuitink
Copy link
Contributor

Further improve the documentation. In the current docs, the examples and explanations are somewhat combined, making it difficult for a (new) user to figure out best practices to work with Wflow. It would be nice to separate the examples from the explanations. Additionally, adding some tutorials and/or clear examples would really benefit the usability as well (see hydromt_wflow docs for a great example).

This would require restructuring of the docs, including new sections. The Documenter.jl package (currently) only supports a menu bar on the left hand side, without different sections such as the hydromt_wflow docs. Adding more sections would make navigating even more difficult (as we are already reaching approaching the limit). Shifting to sphinx would be a solution, but we would lose the direct Julia integration of Documenter.jl: need to figure out the consequences if we want to switch to a different documentation generator.

@JoostBuitink JoostBuitink added documentation Improvements or additions to documentation wishlist Features and/or changes that could be nice in the future labels Oct 31, 2022
@JoostBuitink JoostBuitink moved this to 🔲 Todo in Wflow Oct 31, 2022
@JoostBuitink JoostBuitink removed the status in Wflow Oct 31, 2022
@JoostBuitink JoostBuitink moved this to 🔲 Todo in Wflow Oct 31, 2022
@DirkEilander
Copy link
Contributor

This sphinx-julia package could be something to look in to: https://bastikr.github.io/sphinx-julia/

@visr
Copy link
Member

visr commented Oct 31, 2022

Interesting, I hadn't seen sphinx-julia before. For Bach we've been using Quarto and are quite happy with it. The sections or tabs are are configurable. Overall it's quite well designed and documented. The iMOD team was also considering moving to it.

deltares.github.io/Bach.jl/
https://quarto.org/

@alimeshgi alimeshgi added this to the Q1 milestone Feb 1, 2024
@JoostBuitink JoostBuitink added the v1.0 Activities related to v1.0 label Feb 8, 2024
@JoostBuitink
Copy link
Contributor Author

JoostBuitink commented Mar 14, 2024

Also add some text about developer's guide. Include Rewrap (Wrapping Column of 92)

@JoostBuitink JoostBuitink changed the title Further improve documentation with examples/tutorials Further improve documentation with examples/tutorials and move to Quarto Mar 21, 2024
@alimeshgi alimeshgi added the needs refinement issue still needs refinement label Mar 21, 2024
@alimeshgi alimeshgi modified the milestones: 2024 - Q1, 2024 - Q2 Mar 21, 2024
@JoostBuitink
Copy link
Contributor Author

  • Need some refinement on the actual structure that we will use
  • Discuss with Ribasim team how to setup GitHub actions
  • Copy version switcher from Delft-FIAT
  • Decide whether we still want to link to the current/older docs

@JoostBuitink JoostBuitink removed the wishlist Features and/or changes that could be nice in the future label May 16, 2024
@JoostBuitink JoostBuitink removed the needs refinement issue still needs refinement label May 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation v1.0 Activities related to v1.0
Projects
No open projects
Status: 🔲 Todo
Development

Successfully merging a pull request may close this issue.

4 participants