More organised documentation #1722
debugger24
started this conversation in
Polls
Replies: 1 comment 1 reply
-
|
We have plans to move the docs over to MkDocs hosted in the existing gh-pages site, this looks similar? I don't have especially strong views on MkDocs or not, it's just one of the static site generators that I've used and was alright. |
Beta Was this translation helpful? Give feedback.
1 reply
-
|
Yes, it's similar to jupyterbooks. It uses sphinx behind the scene. I used both jupyterbooks and sphinx for documentation in past projects, really liked it. Don't have a strong opinion on one over the other. |
Beta Was this translation helpful? Give feedback.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
For our docs currently, our README has become quite large and will grow even more in future. Should we create something more organized and interactive like jupyterbooks (or something similar, feel free to add some alternative suggestions)? We can host it on GH Pages.
1 vote ·
Beta Was this translation helpful? Give feedback.
All reactions