docs: pin sphinx version for rtd build

slaclab / pysmurf

Other

2 stars 9 forks source link

docs: pin sphinx version for rtd build #702

Closed BrianJKoopman closed 2 years ago

BrianJKoopman commented 2 years ago

Issue

This PR resolves #701.

Description

This adds a requirements file for the docs builds on readthedocs. In this, we pin the Sphinx version, which resolves the issue seen in #701.

Successful test build here: https://readthedocs.org/projects/pysmurf/builds/15843942/

Does this PR break any interface?

[ ] Yes
[x] No

Which interface changed?

No change.

What was the interface before the change

No change.

What will be the new interface after the change

No change.

agustiner commented 2 years ago

Thanks @BrianJKoopman! Preferably could you throw this on top of develop? I modified the rtd file in there already, and need to test it anyway...

BrianJKoopman commented 2 years ago

Sorry for all the noise, that took a couple of iterations with the rtd build system to figure out.

I swapped the base branch to 'develop'. The rtd config on 'develop' was failing for a couple of reasons. I ended up back at a config that's very similar to the old one on 'main'.

The build is now passing: https://readthedocs.org/projects/pysmurf/builds/15917517/

BrianJKoopman commented 2 years ago

Quick followup. I just noticed the warning that the python.version option is deprecated for build.tools.python, which is what you were using in 'develop'. However, that option was causing a failure on the build system, see: https://readthedocs.org/projects/pysmurf/builds/15917436/