stingray icon indicating copy to clipboard operation
stingray copied to clipboard

Publish multiple versions of stingray docs

Open jdswinbank opened this issue 3 years ago • 5 comments

Stingray's docs are currently built with GitHub Actions, which works well. However, the main downside relative to ReadTheDocs is that we only publish docs for the HEAD of the main branch. Better would be to keep an archive of docs for all releases.

https://github.com/goerz/docs_versions_menu looks like it might make this easy.

jdswinbank avatar May 06 '21 20:05 jdswinbank

@jdswinbank interesting, having multi-version docs is indeed very useful. Do you think it's worth the effort of the additional extension and deploying to different directories etc. instead of just using RTD? If you have a clear idea how to do that, I don't mind :)

matteobachetti avatar May 07 '21 07:05 matteobachetti

I personally don't enjoy using RtD much, so... yeah. :-)

I'm happy to work on this on some rainy Sunday afternoon. I don't think it's a high priority. If you find that you need to get multiple versions of the docs published quickly (before I get around to it), then I've no objection to switching to RtD.

jdswinbank avatar May 07 '21 07:05 jdswinbank

... and we're in the Netherlands, so there are many rainy Sunday afternoons 🤣

dhuppenkothen avatar May 07 '21 08:05 dhuppenkothen

@jdswinbank I have no idea how to do this. Do you think you can find the time in the coming one-two weeks to address this?

matteobachetti avatar Feb 10 '22 10:02 matteobachetti

I'm looking into this with sphinx-versions.

abigailStev avatar Mar 26 '22 21:03 abigailStev

Hey @matteobachetti, I can probably address this, however, one thing I'm curious about is what are we losing by switching to RtD? Because RtD seems like an easy way to solve this issue rather than adding another dependency package.

devanshshukla99 avatar Mar 18 '23 15:03 devanshshukla99

Stingray docs are now back to Readthedocs. Thanks for the brainstorm everyone!

matteobachetti avatar Jan 08 '24 13:01 matteobachetti