search

beakerlib / libraries

Documentation for shared beakerlib libraries and general libraries requests.
2 stars 2 forks source link

ReadTheDocs documentation #13

Open LecrisUT opened 1 year ago

LecrisUT commented 1 year ago

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 commented 1 year ago

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 commented 1 year ago

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

psss commented 1 year ago

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

LecrisUT commented 1 year ago

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

Read the docs configuration page ![Screenshot_20230621_150256](https://github.com/beakerlib/libraries/assets/25577083/1899d94e-0cc6-4030-b2b8-791952dd9091)
psss commented 1 year ago

Thanks for the pointer. Should be enabled now.

LecrisUT commented 1 year ago

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

psss commented 1 year ago

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 commented 1 year ago

I think it doesn't add for current PRs unless they are closed and reopened. But I tried that with https://github.com/teemtee/tmt/pull/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 commented 1 year ago

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 commented 1 year ago

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