search

jpadilla / pyjwt

JSON Web Token implementation in Python
https://pyjwt.readthedocs.io
MIT License
5.17k stars 690 forks source link

Add an RTD config file to resolve RTD build failures #977

Closed kurtmckee closed 3 months ago

kurtmckee commented 3 months ago

The documentation has been failing to build on Read the Docs for a very long time. The builds are failing for lack of a mandatory RTD configuration file (link to final build attempt from 7 months ago).

This PR introduces a preliminary RTD config file.

Separately, I recommend changing the badge in the README, as well, so that it's more apparent when documentation builds are failing. Currently the docs badge is pointing to 'stable', but if it had pointed to 'latest' it would have been much more visible that builds have been failing.

If you want the README updated, let me know and I'll push an additional commit to update the README as well.

kurtmckee commented 2 months ago

@jpadilla It looks like RTD hasn't started building the documentation after this merged. You may need to log into RTD and do something to get it started up again.