Configure for readthedocs

[icemac]

The result looks like this: https://pytest-rerunfailures--284.org.readthedocs.build/284/

[webknjaz]

I recommend wiring Sphinx via tox to avoid maintaining two integrations.

Here's how you call it then: https://github.com/ansible/awx-plugins/blob/e613d5a/.readthedocs.yaml.

[icemac]

@webknjaz This looks way more complicated than what we currently have.

[webknjaz]

@webknjaz This looks way more complicated than what we currently have.

It's necessary if we don't want to have the workflow of building locally for contributors to be "go read the source code and attempt to guess which command to run, where, in what env and how".

[icemac]

@webknjaz I got your point and I added tox environment to build the docs locally. But I am not going to use it at readthedocs. Using their workflow seems way easier.

[webknjaz]

Looks like RTD's command is slightly different: https://app.readthedocs.org/projects/pytest-rerunfailures/builds/26432307/#252451638--1. It's a good idea to keep both places in sync. It's also customary to run the docs build @ GHA additionally to keep the dev env healthy.
Also, htmldir builder produces nicer URLs — consider using it on RTD but keeping html locally.

[icemac]

I do not plan to improve this PR any further.
So I enabled auto-merge and started waiting for a review.
If someone wants to adopt this PR for further improvements, I can disable auto-merge again.

[hugovk]

Thanks!