-
Notifications
You must be signed in to change notification settings - Fork 11
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: pin sphinx version for rtd build #702
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This pull request does not contain a valid label. Please add one of the following labels: bug, enhancement, interface-change
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... |
The base branch was changed.
Build was failing on invalid "build.tools.python.version" option.
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/ |
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/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ship it
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?
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.