Add Readthedocs PR building

[chrisjsewell]

FYI @ekouts you can get RTD to test the build of documentation for PRs: https://docs.readthedocs.io/en/stable/pull-requests.html#preview-documentation-from-pull-requests

Just log in and toggle the "build pull request" button, e.g.:

[chrisjsewell]

Note in the .readthedocs.yml, I would also suggest eventually adding, although at the moment this fails (lots of warnings regarding the docstings)

sphinx:
    fail_on_warning: true

[ekouts]

Thanks! I didn't know about it :) I enabled it and I do see the builds in RTD but it doesn't appear in the PR, I am not sure if it has to do with my permissions in the organization

[chrisjsewell]

Hmm, yeh I remember having some similar issue on one organisation, perhaps try having a look at the webhook and updating it 🤷 :

[ekouts]

Hey, tried that but my problem is Build status is not being reported to your VCS provider and I think the issue is that the eth-cscs organization hasn't granted access to the RTD OAuth app. I have requested the administrators of the org to enable it, but this may take some discussion/time. For now, unfortunately I have to check manually in my rtd account.