Make building the RTD docs a CI check for every PR, and make it required

[jeffwidman]

I noticed that there's no RTD CI check that runs on every PR.

I realize there is a check to ensure docs build successfully, but that only checks local builds. Whereas I've found the RTD check useful on other project I help maintain to catch any drift between RTD required configs and local sphinx.

I went to enable this, but I'm not currently an admin on FactoryBoy's RTD instance.

@rbarrois do you mind adding me as an admin on Factory Boy's RTD?

Mind want to ensure @francoisfreitag is also an admin there to minimize bus factor.

Or if there's some reason this check isn't enabled/required, just let me know...

[rbarrois]

Hi Jeff!

Adding the docs checks might be a good idea, although I thought it was already covered in the docs tox target?

[jeffwidman]

Adding the RTD check verifies not only that the docs build locally, but also that RTD can build them.

For example:

1. currently this project uses setup.py + setup.cfg, but pyproject.toml appears to be the way of the future (Eventually deprecate setup.cfg with automatic conversion to pyproject.toml pypa/setuptools#3214)... if/when that migration happens, it could possibly require updates on .readthedocs.yaml
2. there's pinned versions of python/Ubuntu in this repo's .readthedocs.yaml... easy to forget to update them later.

I don't see any downsides to enabling the automated check? Enabling it is a checkbox on the RTD admin page for the project, it doesn't require adding any workflow files in this repo, so it's really easy...

[jeffwidman]

nudge @rbarrois on ☝

[jeffwidman]

Nudge @rbarrois on this... it possibly would have prevented:

• Documentation is missing for 3.3.1 #1095

[rbarrois]

That's done now, thanks for the suggestion (through the readthedocs API, but not required).