Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Push an updated version of docs to readthedocs #91

Open
frankcarey opened this issue May 18, 2022 · 4 comments
Open

Push an updated version of docs to readthedocs #91

frankcarey opened this issue May 18, 2022 · 4 comments

Comments

@frankcarey
Copy link
Contributor

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.

@AlexSkrypnyk
Copy link
Collaborator

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.

@ocean
Copy link
Collaborator

ocean commented Jul 16, 2022

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
Copy link
Collaborator

ocean commented Jul 16, 2022

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.

@frankcarey
Copy link
Contributor Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants