-
Notifications
You must be signed in to change notification settings - Fork 6
Open
Labels
Description
Context
Hosting the doc on RTD has some issues:
- we've been struggling with RTD in the past (their own build environment is somewhat limited, and we've had some issues because of that)
- minor issue: RTD free version has some annoying ads (although it only costs $5/mo to get rid of it)
- minor issue: the URL is not super nice (i personally find "readthedocs.org" slightly condescending), whereas github.io looks better
It would be nice to find a solution for hosting a sphinx-built documentation outside of RTD. Recently i bumped into this great example: https://brainsprite.github.io/. This doc is hosted on github page, but built via sphinx by circle CI. The source is hosted there: https://github.com/brainsprite/brainsprite.github.io. I believe we could do something similar for this website: https://spine-generic.readthedocs.io/en/latest/, using github actions, triggered from this website: https://github.com/spine-generic/spine-generic. I've already created this "html hosting doc" repository here. So the next step would consist in setting up the GH action and deployment.
Some potentially useful sources: