python-zk / kazoo

Kazoo is a high-level Python library that makes it easier to use Apache Zookeeper.
https://kazoo.readthedocs.io
Apache License 2.0
1.3k stars 386 forks source link

chore(core): Fix documentation build #710

Closed ceache closed 1 year ago

ceache commented 1 year ago

Fixes #699

Why is this needed?

Configure readthedocs documentation build directly in the project.

Proposed Changes

Does this PR introduce any breaking change?

No

ceache commented 1 year ago

@python-zk/core-committers it would be nice if we could integrate the readthedocs webhook so that each PR generate a documentation build.

See for example https://ceache-kazoo--5.org.readthedocs.build/en/5/index.html

codecov[bot] commented 1 year ago

Codecov Report

Base: 94.35% // Head: 94.65% // Increases project coverage by +0.29% :tada:

Coverage data is based on head (e24e120) compared to base (5225b3e). Patch has no changes to coverable lines.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #710 +/- ## ========================================== + Coverage 94.35% 94.65% +0.29% ========================================== Files 57 57 Lines 8339 8339 ========================================== + Hits 7868 7893 +25 + Misses 471 446 -25 ``` | [Impacted Files](https://codecov.io/gh/python-zk/kazoo/pull/710?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=python-zk) | Coverage Δ | | |---|---|---| | [kazoo/recipe/barrier.py](https://codecov.io/gh/python-zk/kazoo/pull/710?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=python-zk#diff-a2F6b28vcmVjaXBlL2JhcnJpZXIucHk=) | `97.93% <0.00%> (-2.07%)` | :arrow_down: | | [kazoo/tests/test\_lock.py](https://codecov.io/gh/python-zk/kazoo/pull/710?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=python-zk#diff-a2F6b28vdGVzdHMvdGVzdF9sb2NrLnB5) | `99.13% <0.00%> (+0.17%)` | :arrow_up: | | [kazoo/client.py](https://codecov.io/gh/python-zk/kazoo/pull/710?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=python-zk#diff-a2F6b28vY2xpZW50LnB5) | `98.08% <0.00%> (+0.31%)` | :arrow_up: | | [kazoo/recipe/queue.py](https://codecov.io/gh/python-zk/kazoo/pull/710?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=python-zk#diff-a2F6b28vcmVjaXBlL3F1ZXVlLnB5) | `98.08% <0.00%> (+0.63%)` | :arrow_up: | | [kazoo/tests/test\_gevent\_handler.py](https://codecov.io/gh/python-zk/kazoo/pull/710?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=python-zk#diff-a2F6b28vdGVzdHMvdGVzdF9nZXZlbnRfaGFuZGxlci5weQ==) | `79.57% <0.00%> (+0.70%)` | :arrow_up: | | [kazoo/handlers/utils.py](https://codecov.io/gh/python-zk/kazoo/pull/710?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=python-zk#diff-a2F6b28vaGFuZGxlcnMvdXRpbHMucHk=) | `94.97% <0.00%> (+0.91%)` | :arrow_up: | | [kazoo/protocol/connection.py](https://codecov.io/gh/python-zk/kazoo/pull/710?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=python-zk#diff-a2F6b28vcHJvdG9jb2wvY29ubmVjdGlvbi5weQ==) | `96.48% <0.00%> (+1.03%)` | :arrow_up: | | [kazoo/tests/test\_eventlet\_handler.py](https://codecov.io/gh/python-zk/kazoo/pull/710?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=python-zk#diff-a2F6b28vdGVzdHMvdGVzdF9ldmVudGxldF9oYW5kbGVyLnB5) | `88.52% <0.00%> (+1.09%)` | :arrow_up: | | [kazoo/tests/test\_cache.py](https://codecov.io/gh/python-zk/kazoo/pull/710?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=python-zk#diff-a2F6b28vdGVzdHMvdGVzdF9jYWNoZS5weQ==) | `59.52% <0.00%> (+4.42%)` | :arrow_up: | Help us with your feedback. Take ten seconds to tell us [how you rate us](https://about.codecov.io/nps?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=python-zk). Have a feature suggestion? [Share it here.](https://app.codecov.io/gh/feedback/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=python-zk)

:umbrella: View full report at Codecov.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.

jeffwidman commented 1 year ago

I thought I had already set that up? All my PRs result in an email to me that the rtd build failed. If still missing anything feel free to set it up now that you're an admin on RTD for kazoo.

a-ungurianu commented 1 year ago

Could we somehow get https://docs.readthedocs.io/en/stable/pull-requests.html to work as well?

EDIT: I see @ceache already asked this. Missed that!

ceache commented 1 year ago

I have resynch'd the readthedocs webhook and now we have docs build check right there in the PR!

jeffwidman commented 1 year ago

Thanks @ceache, much appreciated!