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

fix: Add sphinx_rtd_theme to extensions #2220

Merged
merged 1 commit into from
May 23, 2023

Conversation

matthewfeickert
Copy link
Member

@matthewfeickert matthewfeickert commented May 22, 2023

Description

sphinx_rtd_theme must be added to the sphinx extensions in sphinx v6.0+ to properly load jQuery.

Checklist Before Requesting Reviewer

  • Tests are passing
  • "WIP" removed from the title of the pull request
  • Selected an Assignee for the PR to be responsible for the log summary

Before Merging

For the PR Assignees:

  • Summarize commit messages into a comprehensive review of the PR
* sphinx_rtd_theme must be added to the sphinx extensions in sphinx v6.0+
  to properly load jQuery.
   - c.f. https://sphinx-rtd-theme.readthedocs.io/en/1.2.0/changelog.html#known-issues

@matthewfeickert matthewfeickert added docs Documentation related fix A bug fix labels May 22, 2023
@matthewfeickert matthewfeickert self-assigned this May 22, 2023
@matthewfeickert matthewfeickert added the need-to-backport tmp label until can be backported to patch release branch label May 22, 2023
* sphinx_rtd_theme must be added to the sphinx extensions in sphinx
 v6.0+ to properly load jquery.
   - c.f. https://sphinx-rtd-theme.readthedocs.io/en/1.2.0/changelog.html#known-issues
@matthewfeickert matthewfeickert force-pushed the docs/fix-menu-on-mobile branch from 50d757f to ebe0b34 Compare May 23, 2023 00:52
@matthewfeickert matthewfeickert marked this pull request as ready for review May 23, 2023 00:53
@codecov
Copy link

codecov bot commented May 23, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (2219abf) 98.30% compared to head (ebe0b34) 98.30%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2220   +/-   ##
=======================================
  Coverage   98.30%   98.30%           
=======================================
  Files          69       69           
  Lines        4533     4533           
  Branches      802      802           
=======================================
  Hits         4456     4456           
  Misses         45       45           
  Partials       32       32           
Flag Coverage Δ
contrib 97.88% <ø> (ø)
doctest 61.08% <ø> (ø)
unittests-3.10 96.31% <ø> (ø)
unittests-3.11 96.31% <ø> (ø)
unittests-3.8 96.33% <ø> (ø)
unittests-3.9 96.36% <ø> (ø)

Flags with carried forward coverage won't be shown. 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.

@matthewfeickert
Copy link
Member Author

I'm going to approve and merge this myself. As always, PRs approved by a single core dev can be reverted as needed by the rest of the dev team.

@matthewfeickert matthewfeickert merged commit 980eb73 into main May 23, 2023
@matthewfeickert matthewfeickert deleted the docs/fix-menu-on-mobile branch May 23, 2023 02:07
@matthewfeickert matthewfeickert removed the need-to-backport tmp label until can be backported to patch release branch label May 23, 2023
matthewfeickert added a commit that referenced this pull request May 23, 2023
* Backport PR #2220
* sphinx_rtd_theme must be added to the sphinx extensions in sphinx v6.0+
  to properly load jQuery.
   - c.f. https://sphinx-rtd-theme.readthedocs.io/en/1.2.0/changelog.html#known-issues
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related fix A bug fix
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

ReadThe Docs version selection not working Menu on mobile page not accessible for pyhf v0.7.1 docs
1 participant