ahoy icon indicating copy to clipboard operation
ahoy copied to clipboard

Push an updated version of docs to readthedocs

Open frankcarey opened this issue 2 years ago • 4 comments

While things are fixed in the repo, there needs to be a new push to readthedocs here https://ahoy-cli.readthedocs.io/en/latest/ to actually update the image.

frankcarey avatar May 18 '22 14:05 frankcarey

We have documentation in docs directory and have instructions on how to build documentation locally. However, there are no instructions on how this documentation is published to https://ahoy-cli.readthedocs.io/

It would be great to have instructions about how the documentation is published.

Also, it may be worth considering to switch to a more simplified workflow to use GitHub pages OR CI-driven workflow to automatically push documentation updates to https://ahoy-cli.readthedocs.io/ on release.

AlexSkrypnyk avatar Jul 15 '22 21:07 AlexSkrypnyk

What a coincidence you're working on this today as well :) I'm stuck in a hotel in Perth with Covid and so was going to have a look at ahoy this weekend too.

ocean avatar Jul 16 '22 00:07 ocean

The readme in the docs directory says a little, but when I installed and ran Sphinx it spat out a lot of errors, I think the versions and config would need revising.

I tried mkdocs which seems simpler and is also supported by ReadTheDocs, but it still needs some work and looked like it would need new templates and add more weight.

Also, I think ReadTheDocs integration might be another one of the semi-bound things to the GH repo/org that @frankcarey might have to re-enable or reset in some way. I signed in to ReadTheDocs through GH but can't see a way to attach/update.

I think the idea of moving to GH Pages is pretty good, less moving parts and we can update to a newer docs theme etc. Only issue is the main domain still will point to RTD, but maybe we can change that one day.

ocean avatar Jul 16 '22 00:07 ocean

Ghpages is fine. Maybe we can simply update readthedocs content to link to the ghpages too. Let me know where I can help best.

frankcarey avatar Jul 16 '22 00:07 frankcarey