readthedocs.org Out of sync

[AlbertMietus]

The docs of breathe on RTfD look very old

See:
https://readthedocs.org/projects/breathe/builds/

[vermeeren]

@michaeljones do you have any idea what is up with RTD and how it works? I assume it is tied to some sort of account in some way?

[vermeeren]

@michaeljones Can you check the above and see what the problem is in RTD? Only your name is in the maintainers profile of RTD, see https://readthedocs.org/projects/breathe/.

If you don't have time that's also fine, could you leave a reply in that case too? I intend to move official Breathe docs to one of my (self-maintained) webservers in that case, as I am not familiar with RTD.

[michaeljones]

@vermeeren - sorry, I have been in the habit of dismissing Breathe notifications. I certainly have time to explore this. I'll have a look.

[michaeljones]

@vermeeren - not that I wish to put more responsibility on your shoulders but I can add you to the readthedocs project if you sign up there? At least then I'm not a single point of failure.

[vermeeren]

@michaeljones Yeah that's probably a good idea, just created an account, username is vermeeren as usual.

[michaeljones]

@vermeeren - done!

[vermeeren]

@michaeljones Can you further setup the webhook for RTD on the GitHub side? This needs to be done in the settings of the Breathe project. The page here on RTD will have the webhook with the API URL: https://readthedocs.org/dashboard/breathe/integrations/

For the GitHub side see https://docs.readthedocs.io/en/stable/webhooks.html#github

I think with this change builds will be triggered near-instantly when things are changed in master, too big of a delay (or maybe only manual builds?) currently.

[michaeljones]

Thanks for the heads up. I was wondering why there wasn't a long trail of failures on the RTD side.

I have attempted to get this set up correctly. I don't know if I was successful. I don't have anything meaning full to push to master at this time to trigger it.

[vermeeren]

I'll check the RTD status the next time something is merged into master, hopefully things work fine so this issue can be closed at that time. Thanks!

[vermeeren]

@michaeljones Checking the page at https://readthedocs.org/dashboard/breathe/integrations/ it currently gives a 400 bad request, from the exchange log:

{
  "detail": "Payload not valid, invalid or missing signature"
}

I cannot see the GitHub side of things but I suspect something isn't setup properly there or there needs to be a "resync webhook" action on RTD side. Could you check a bit further?

[michaeljones]

Thanks for the heads up. I'll look into it.

[michaeljones]

The advice seems to be to delete and re-create the integrations on both sides. I've done that. Oddly Github seems to create two webhook entries so I've deleted the one that seemed to be unnecessary.

I've attempted to test it by pushing a "test-rtd" branch and that seems to have triggered 200 (success) on the ReadTheDocs side. I'm afraid we're going to have to once more wait and see if it behaves itself for the master branch but I think it is looking more hopeful.

[vermeeren]

I just found it still fails, notably RTD does the following:

 /home/docs/checkouts/readthedocs.org/user_builds/breathe/envs/latest/bin/python -m pip install --upgrade --no-cache-dir Pygments==2.3.1 setuptools==41.0.1 docutils==0.14 mock==1.0.1 pillow==5.4.1 alabaster>=0.7,<0.8,!=0.7.5 commonmark==0.8.1 recommonmark==0.5.0 sphinx<2 sphinx-rtd-theme<0.5 readthedocs-sphinx-ext<1.1 

I noticed the .readthedocs.yml just needs to be updated to fix this, using our project's requirements.txt properly. https://docs.readthedocs.io/en/stable/config-file/v2.html

I will create patch for this within a few hours hopefully.

[michaeljones]

Thank you for handling it, @vermeeren.