New documentation format using Read the Docs #487
set-soft
announced in
Announcements
Replies: 1 comment 2 replies
-
Hi @set-soft, I spent tens of hours on the Reamed.md the last months without knowing there was a readthedocs.io page. I discovered it by chance reading one of your issue comments. I think it would be nice to advertise it more with a link at the very beginning of the Readme.md |
Beta Was this translation helpful? Give feedback.
2 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
Hi All!
I moved the old monolithic markdown doc to a more modular reST doc. The new docs are rendered by Sphinx using the Read the Docs theme and hosting:
https://kibot.readthedocs.io/en/latest/
I think this is easier to navigate and search.
One interesting thing about Read the Docs is that it supports versions, so we will be able to keep docs for different KiBot versions. This is something I think we can't do using GitHub pages. At least not in a simple and efficient way.
The drawback is that Read the Docs uses ads, but they aren't intrusive.
Comments are welcome.
Beta Was this translation helpful? Give feedback.
All reactions