ReadTheDocs documentation

[LecrisUT]

ReadTheDocs supports subprojects, meaning that the rtd pages built on this repo can be custom pages on either beakerlib.readthedocs.io or tmt.readthedocs.io.

This is helpful because there will be a central place to find all of the libraries.

Pinging: @lukaszachy @psss @sopos

[psss]

Nice idea! Sounds good to me to provide the list of available beakerlib libraries directly in the documentation. I'd say beakerlib.readthedocs.io would be a better choice for the lib details and add a link to the page from the tmt documentation.

[LecrisUT]

Great to hear :). Can you enable RTD on tmt PRs so I can test the integration later on?

[psss]

This is done using the github action?
https://github.com/marketplace/actions/sphinx-docs-build-with-readthedocs-docker

[LecrisUT]

No, it's in the RTD configuration of the tmt project. I am still trying to get RTD to work with GH actions: readthedocs/actions#27.

Read the docs configuration page

[psss]

Thanks for the pointer. Should be enabled now.

[LecrisUT]

Oh I forgot to mention (had this happen to me several times), don't forget to hit save :D.

[psss]

Oh I forgot to mention (had this happen to me several times), don't forget to hit save :D.

Hm, I've updated, and saved, but no new status appears in the fresh pull requests. Not even after adding new commits. Is there anything missing in the tmt repo?

[LecrisUT]

I think it doesn't add for current PRs unless they are closed and reopened. But I tried that with teemtee/tmt#2098 and I don't see any changes here. The only other thing I can think of is to check the webhook settings and recent deliveries there. Make sure pull_request events are sent.

[psss]

The only other thing I can think of is to check the webhook settings and recent deliveries there. Make sure pull_request events are sent.

Yes, that was it. Thanks for the hint!

[LecrisUT]

Great, it doesn't even require closing and reopening PRs.