pypdf icon indicating copy to clipboard operation
pypdf copied to clipboard

Read the Docs is outdated

Open stefan6419846 opened this issue 2 years ago • 1 comments

Read the Docs currently seems to ship the docs for version 4.0.1 at the moment, although 4.0.2 has been released in the meantime.

I initially stumbled upon this due to the incomplete changelog at https://pypdf.readthedocs.io/en/latest/meta/CHANGELOG.html According to the build history, version 4.0.2 has never been triggered at all: https://readthedocs.org/projects/pypdf/builds/

stefan6419846 avatar Feb 28 '24 16:02 stefan6419846

@MartinThoma Do you have an idea why the last release apparently did not trigger the docs build?

stefan6419846 avatar Feb 28 '24 16:02 stefan6419846

Is it possible that as pypdf has grown it now times out the process? Are there any log files produced?

j-t-1 avatar Mar 26 '24 07:03 j-t-1

From the https://readthedocs.org/projects/pypdf/builds/ link, it would seem that RTD was being regularly triggered on any commit to main as well as new tags until the 4.0.1 release (https://github.com/py-pdf/pypdf/commit/757932944f54ba661b89e0629ed3fc9d8345dbab), at which point no builds were triggered going forward.

I wonder if @MartinThoma had revoked something in RTD that made it no longer able to pick up new commits to the repo and build the appropriate latest or stable tags.

MasterOdin avatar Mar 26 '24 11:03 MasterOdin

Yes, this is something which most likely only Martin can answer, thus I assigned him directly. RTD has at least some basic configuration options regarding this.

stefan6419846 avatar Mar 26 '24 13:03 stefan6419846

I only noticed this ticket. Sorry for the delay. I'll have a look today.

MartinThoma avatar Mar 27 '24 16:03 MartinThoma

I wonder if @MartinThoma had revoked something in RTD that made it no longer able to pick up new commits to the repo and build the appropriate latest or stable tags.

I didn't touch RTD for quite a while

MartinThoma avatar Mar 27 '24 16:03 MartinThoma

image

MartinThoma avatar Mar 27 '24 16:03 MartinThoma

I've re-connected / gave the permissions, but RTD still claims that it does not have access. I manually triggered the build now.

MartinThoma avatar Mar 27 '24 16:03 MartinThoma

https://blog.readthedocs.com/security-update-on-incoming-webhooks/ seems related

MartinThoma avatar Mar 27 '24 16:03 MartinThoma

Ok, I think things look good now. Hever, I still see the error message on RTD from above:

Could not send GitHub build status report for "pypdf". Make sure you have the correct GitHub repository permissions and your GitHub account is connected to Read the Docs.

MartinThoma avatar Mar 27 '24 17:03 MartinThoma

image

Seems to work, though

MartinThoma avatar Mar 27 '24 17:03 MartinThoma

Thanks, it seems to be running again, although more often than before? In the past, we would only update the docs on a release/tag, now it seems like even PRs get a dedicated rendered page and each commit to the main branch triggers an up-to-date build. This should not really hurt, I just happened to stumble upon this when looking at my latest PR ;)

stefan6419846 avatar Mar 27 '24 18:03 stefan6419846

Thanks, it seems to be running again, although more often than before? In the past, we would only update the docs on a release/tag, now it seems like even PRs get a dedicated rendered page and each commit to the main branch triggers an up-to-date build. This should not really hurt, I just happened to stumble upon this when looking at my latest PR ;)

I've seen the same. From an ecological point of view this is not so good. What about checking if the title starts with REL: to engage the process ?

pubpub-zz avatar Mar 27 '24 21:03 pubpub-zz

I started the build process a couple of times manually. Maybe you have seen that?

However, we did run it for every single PR as well since many months. The reason is that we can check changes in the docs before we merge it.

MartinThoma avatar Mar 27 '24 21:03 MartinThoma

I close this as solved. If we observe the issue back, we will reopen it

pubpub-zz avatar Apr 02 '24 19:04 pubpub-zz