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

Pin Sphinx < 7 and build without setuptools hook #549

Merged
merged 2 commits into from
Jun 16, 2023

Conversation

mferrera
Copy link
Collaborator

@mferrera mferrera commented Jun 16, 2023

Sphinx >= 7 deprecates building docs through its setuptools hook and deprecates the style HTML key that is used by the sphinx_rtd_theme. The theme has not yet been updated to address this change.

@codecov-commenter
Copy link

codecov-commenter commented Jun 16, 2023

Codecov Report

Merging #549 (9f19bce) into master (d072f09) will decrease coverage by 0.02%.
The diff coverage is 87.87%.

❗ Current head 9f19bce differs from pull request most recent head 318e4d4. Consider uploading reports for the commit 318e4d4 to get more accurate results

@@            Coverage Diff             @@
##           master     #549      +/-   ##
==========================================
- Coverage   86.21%   86.20%   -0.02%     
==========================================
  Files          49       49              
  Lines        7045     7037       -8     
==========================================
- Hits         6074     6066       -8     
  Misses        971      971              
Impacted Files Coverage Δ
src/subscript/pack_sim/pack_sim.py 89.77% <87.87%> (-0.31%) ⬇️

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@mferrera mferrera changed the title Build Sphinx without setuptools hook Pin Sphinx < 7 and build without setuptools hook Jun 16, 2023
mferrera added 2 commits June 16, 2023 08:14
Sphinx 7 deprecates the usage of the `style` HTML key in templates
and the sphinx_rtd_theme package has not yet been updated to address
this change.
@mferrera mferrera force-pushed the deprecate-build_sphinx branch from d541299 to 318e4d4 Compare June 16, 2023 06:21
@mferrera mferrera requested review from alifbe and rnyb June 16, 2023 06:30
@alifbe
Copy link
Collaborator

alifbe commented Jun 16, 2023

@mferrera will this resolve the issue that Sondre flag? I wonder why it only fails on subscript docs but not other documentation.

@mferrera
Copy link
Collaborator Author

Yep!

@mferrera
Copy link
Collaborator Author

It seems most other repositories have already pinned Sphinx. I have seen it pinned to 4, 5, 6 in various repositories. I'm more surprised that subscript has lasted so long without pinning 😅

Copy link
Collaborator

@alifbe alifbe left a comment

Choose a reason for hiding this comment

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

Looks good to me and good job with updating action version. 👍

@mferrera mferrera merged commit e5e3f72 into equinor:master Jun 16, 2023
@mferrera mferrera deleted the deprecate-build_sphinx branch June 16, 2023 06:52
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.

3 participants