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: Fix broken pytest fixture #546

Merged
merged 14 commits into from
Sep 26, 2023
Merged

Conversation

peytondmurray
Copy link
Contributor

@peytondmurray peytondmurray commented Sep 26, 2023

Summary

This PR fixes an instance where a myst-nb test fixture was using a test fixture that was previously provided by sphinx but was removed sometime between the release of 6.2.1 and 7.2.6. Closes #545. This should also unblock a new release.

Changes

  • Swapped out the tempdir fixture for pytest's tmpdir fixture as a drop-in replacement.

@welcome
Copy link

welcome bot commented Sep 26, 2023

Thanks for submitting your first pull request! You are awesome! 🤗

If you haven't done so already, check out EBP's Code of Conduct and our Contributing Guide, as this will greatly help the review process.

Welcome to the EBP community! 🎉

Copy link
Collaborator

@agoose77 agoose77 left a comment

Choose a reason for hiding this comment

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

This is a good PR! Let me address the remainder of the failures.

# TODO: Remove when support for Sphinx<=6 is dropped,
re.escape(" translation_progress=\"{'total': 0, 'translated': 0}\""),
# TODO: Remove when support for Sphinx<7.2 is dropped,
r"original_uri=\"[^\"]*\"\s",
Copy link
Collaborator

Choose a reason for hiding this comment

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

This is a hack. But, I don't think it's the end of the world.

@codecov
Copy link

codecov bot commented Sep 26, 2023

Codecov Report

All modified lines are covered by tests ✅

Files Coverage Δ
myst_nb/core/execute/cache.py 97.82% <100.00%> (ø)
myst_nb/core/render.py 85.28% <100.00%> (ø)
myst_nb/sphinx_.py 89.74% <ø> (ø)

📢 Thoughts on this report? Let us know!.

@agoose77 agoose77 merged commit afb72ab into executablebooks:master Sep 26, 2023
21 checks passed
@welcome
Copy link

welcome bot commented Sep 26, 2023

Congrats on your first merged pull request in this project! 🎉
congrats

Thank you for contributing, we are very proud of you! ❤️

@peytondmurray peytondmurray deleted the fix-ci branch September 26, 2023 16:37
@peytondmurray
Copy link
Contributor Author

Thanks so much for the support getting this merged!

@agoose77 agoose77 changed the title [Doc] Fix broken pytest fixture DOCS: Fix broken pytest fixture Sep 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Tests which use the sphinx_run fixture are broken for sphinx>7; failing CI results
2 participants