robota-suite / robota-core

A Python package for reading in elements of GitLab and GitHub repositories, for further analysis.
https://robota-core.readthedocs.io
MIT License
0 stars 8 forks source link

publish docs #22

Open SauravMaheshkar opened 1 month ago

SauravMaheshkar commented 1 month ago

Read the docs allows for free building and hosting of documentation sites and offers close knit support for sphinx. Github pages could also be a nice alternative.

suzanneEmbury commented 3 weeks ago

A good point, @SauravMaheshkar . We already have our docs on Read the Docs:

https://robota-core.readthedocs.io/en/latest/index.html

But I don't think we link to it from the GitHub repository effectively, and we don't yet publish directly from GitHub. It would be fantastic if you were willing to put together a PR that automatically built and published updated docs to Read the Docs for each release we make here.

SauravMaheshkar commented 3 weeks ago

Sounds good. Will make a PR soon. Till then perhaps a easy way to link to the documentation from the repository is to add it as a website in the repository settings.

How it looks How to configure
Screenshot 2024-06-07 at 12 21 31 AM Screenshot 2024-06-07 at 12 22 50 AM
suzanneEmbury commented 3 weeks ago

Good suggestion, thanks. I've done that now.