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

remove mistune pin and increase minimum sphinx-asdf version #7696

Merged
merged 3 commits into from
Jul 5, 2023

Conversation

braingram
Copy link
Collaborator

@braingram braingram commented Jul 5, 2023

This PR removes the mistune dependency (and pin).

This pin appears to have been added to deal with sphinx-asdf 0.1.1 not pinning mistune and a new version of mistune being released which broke the docs.
#6490

The pin was also added to sphinx-asdf 0.1.2 so bumping the minimum version of sphinx-asdf 0.1.2 means the mistune pin is no longer needed in jwst. This PR increases the minimum version of sphinx-asdf to 0.1.2

Removing this pin allows sphinx-asdf 0.2.0 to be installed which removes many of the deprecated call warnings when building the docs.

As can be seen by comparing this docs build log for this PR
https://readthedocs.org/projects/jwst-pipeline/builds/21213123/
to a build log for a PR where sphinx-asdf<0.2.0 is used:
https://readthedocs.org/projects/jwst-pipeline/builds/21211054/

Checklist for maintainers

  • added entry in CHANGES.rst within the relevant release section
  • updated or added relevant tests
  • updated relevant documentation
  • added relevant milestone
  • added relevant label(s)
  • ran regression tests, post a link to the Jenkins job below.
    How to run regression tests on a PR
  • Make sure the JIRA ticket is resolved properly

sphinx-asdf 0.1.2 added the mistune pin that this commit removes
from jwst (so 0.1.2 is equivalent to 0.1.1 with the pin)

keeping the pin does not allow jwst to use sphinx-asdf 0.2.0
(which requires mistune >= 3.0.0)
@braingram braingram marked this pull request as ready for review July 5, 2023 20:19
@braingram braingram requested a review from a team as a code owner July 5, 2023 20:19
@codecov
Copy link

codecov bot commented Jul 5, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (14e4e96) 76.56% compared to head (c745ca6) 76.56%.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #7696   +/-   ##
=======================================
  Coverage   76.56%   76.56%           
=======================================
  Files         456      456           
  Lines       36877    36877           
=======================================
  Hits        28234    28234           
  Misses       8643     8643           
Flag Coverage Δ *Carryforward flag
nightly 77.43% <ø> (ø) Carriedforward from 14e4e96

*This pull request uses carry forward flags. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@hbushouse hbushouse added this to the Build 10.0 milestone Jul 5, 2023
Copy link
Collaborator

@hbushouse hbushouse left a comment

Choose a reason for hiding this comment

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

LGTM

@hbushouse hbushouse merged commit 041c730 into spacetelescope:master Jul 5, 2023
@braingram braingram deleted the remove_mistune_pin branch July 6, 2023 00:00
@braingram braingram restored the remove_mistune_pin branch July 6, 2023 22:01
@braingram braingram deleted the remove_mistune_pin branch July 6, 2023 22:01
@hbushouse hbushouse modified the milestones: Build 10.0, Build 9.3 Jul 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants