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.

Sign up for GitHub

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

Jump to bottom

build docs with python 3.10 #180

Merged
merged 1 commit into from
Jul 7, 2023
Merged

build docs with python 3.10 #180

merged 1 commit into from
Jul 7, 2023

Conversation

braingram
Copy link
Collaborator

@braingram braingram commented Jul 7, 2023 •
edited
Loading

sphinx-asdf 0.2.0 fails for some uses in python 3.11 (see: asdf-format/sphinx-asdf#72).

This PR temporarily switches the docs to build in 3.10 until an update can be released for sphinx-asdf.

Checklist

  • added entry in CHANGES.rst (either in Bug Fixes or Changes to API)
  • updated relevant tests
  • updated relevant documentation
  • updated relevant milestone(s)
  • added relevant label(s)

@braingram braingram added the no-changelog-entry-needed Trivial change that doesn't need an entry in the change log label Jul 7, 2023
@braingram braingram marked this pull request as ready for review July 7, 2023 20:20
@braingram braingram requested a review from a team as a code owner July 7, 2023 20:20
@braingram braingram mentioned this pull request Jul 7, 2023
Merged
5 tasks
tapastro
tapastro reviewed Jul 7, 2023
View reviewed changes
Copy link
Collaborator

@tapastro tapastro left a comment

Choose a reason for hiding this comment

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

Has this been tested with e.g. PR#178 to see if it fixes the issue?

This was referenced Jul 7, 2023
Merged
Closed
@braingram
Copy link
Collaborator Author

Has this been tested with e.g. PR#178 to see if it fixes the issue?

Thanks for taking a look! Locally I can build with 3.10 (but not 3.11). I opened a test PR that applies the changes in this PR and #178 to see if read the docs builds.

The build passed see build log here: https://readthedocs.org/projects/stdatamodels/builds/21236522/

tapastro
tapastro approved these changes Jul 7, 2023
View reviewed changes
Copy link
Collaborator

@tapastro tapastro left a comment

Choose a reason for hiding this comment

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

Ah, I thought the failure was a result of that PR, but I see that it's a general issue with existing documentation - is that right? Regardless, this PR seems reasonable enough.

@braingram
Copy link
Collaborator Author

Ah, I thought the failure was a result of that PR, but I see that it's a general issue with existing documentation - is that right? Regardless, this PR seems reasonable enough.

Yes! I just released sphinx-asdf (used by stdatamodels to build docs) with some changes. One change (a regex modification) combined with an updated dependency makes sphinx-asdf fail for certain uses in python 3.11 (so far the only one I've seen is in stdatamodels).

Thanks for the review. Hopefully I can clean up the mess soon.

@braingram braingram merged commit 6afbbf7 into spacetelescope:master Jul 7, 2023
@braingram braingram deleted the docs_3p10 branch July 7, 2023 20:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tapastro tapastro tapastro approved these changes

Assignees
No one assigned
Labels
no-changelog-entry-needed Trivial change that doesn't need an entry in the change log
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@braingram @tapastro