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

Upgrade sphinx version by removing sphinx_panels dependency #208

Merged
merged 1 commit into from
Feb 21, 2023

Conversation

JBGreisman
Copy link
Member

The documentation used a deprecated sphinx extension called sphinx_panels. This update switches to the updated version called sphinx_design. This should make it so that a later version of sphinx can be used for building documentation, which resolves the jinja2 version issue from #202 and as a side effect also resolves the issue identified in #206.

This worked locally without the need for setting an explicit minimal sphinx version in setup.py, but it might behave differently in the CI.

@JBGreisman JBGreisman added the documentation Issue related to documentation label Feb 21, 2023
@JBGreisman
Copy link
Member Author

Based on the documentation test, the changes here did indeed boost the sphinx version from 3.5.3 --> 5.3.0

@JBGreisman JBGreisman linked an issue Feb 21, 2023 that may be closed by this pull request
@codecov-commenter
Copy link

codecov-commenter commented Feb 21, 2023

Codecov Report

Merging #208 (e1a22aa) into main (9294621) will not change coverage.
The diff coverage is n/a.

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

@@           Coverage Diff           @@
##             main     #208   +/-   ##
=======================================
  Coverage   98.39%   98.39%           
=======================================
  Files          45       45           
  Lines        1803     1803           
=======================================
  Hits         1774     1774           
  Misses         29       29           
Flag Coverage Δ
unittests 98.39% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

@JBGreisman JBGreisman merged commit ebe7451 into main Feb 21, 2023
@JBGreisman JBGreisman deleted the update_docs branch February 21, 2023 14:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Issue related to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

API reference website display
2 participants