Skip to content
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

Merged
merged 6 commits into from
Feb 4, 2022
Merged

Conversation

BrianJKoopman
Copy link
Collaborator

@BrianJKoopman BrianJKoopman commented Jan 21, 2022

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
  • 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.

Sorry, something went wrong.

agustiner and others added 2 commits November 8, 2021 08:56
Update pysmurf to Rogue v4.11.10 and cryo-det v1.1.0. Major changes is the cryo-det U_timing messages were increased in size, the version number of cryo-det was incremented, and minor changes to Rogue.
@github-actions github-actions bot added the client Changes to the client code label Jan 21, 2022
Copy link

@github-actions github-actions bot left a 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

swh76
swh76 previously approved these changes Jan 21, 2022
agustiner
agustiner previously approved these changes Jan 25, 2022
@agustiner
Copy link
Member

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 BrianJKoopman changed the base branch from main to develop January 28, 2022 20:55
@BrianJKoopman BrianJKoopman dismissed stale reviews from agustiner and swh76 January 28, 2022 20:55

The base branch was changed.

@BrianJKoopman
Copy link
Collaborator Author

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
Copy link
Collaborator Author

BrianJKoopman commented Jan 28, 2022

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/

Copy link
Member

@agustiner agustiner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ship it

@agustiner agustiner merged commit 418137f into develop Feb 4, 2022
@BrianJKoopman BrianJKoopman deleted the koopman/fix-rtd-builds branch February 4, 2022 18:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
client Changes to the client code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Readthedocs builds currently broken
3 participants