Title: Doc: Fix search for sphinx >=1.8 by ImportanceOfBeingErnest · Pull Request #12216 · matplotlib/matplotlib · GitHub
Open Graph Title: Doc: Fix search for sphinx >=1.8 by ImportanceOfBeingErnest · Pull Request #12216 · matplotlib/matplotlib
X Title: Doc: Fix search for sphinx >=1.8 by ImportanceOfBeingErnest · Pull Request #12216 · matplotlib/matplotlib
Description: PR Summary Sphinx 1.8 broke the matplolib search as seen in #12183. The issue is sphinx-doc/sphinx#5460 but it will not be fixed from the sphinx side. Instead they propose a solution as seen in readthedocs/sphinx_rtd_theme#672. This makes it necessary to change the layout.html manually to include some new javascript file that defines some variables that are needed by the javascript that does the searching. This PR is changing the layout.html in the same manner, such that the seach is functional again. Here is the link to the operational search. At the moment sphinx 1.8.0 is excluded in the requirements, but since 1.8.1 is out already, it'll be used by automatically by test environments etc. It remains to be discussed whether sphinx should be pinned to 1.7.9 until the remaining issues (related to the change of :math:) are fixed. PR Checklist Has Pytest style unit tests Code is Flake 8 compliant New features are documented, with examples if plot related Documentation is sphinx and numpydoc compliant Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there) Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way
Open Graph Description: PR Summary Sphinx 1.8 broke the matplolib search as seen in #12183. The issue is sphinx-doc/sphinx#5460 but it will not be fixed from the sphinx side. Instead they propose a solution as seen in rea...
X Description: PR Summary Sphinx 1.8 broke the matplolib search as seen in #12183. The issue is sphinx-doc/sphinx#5460 but it will not be fixed from the sphinx side. Instead they propose a solution as seen in rea...
Opengraph URL: https://github.com/matplotlib/matplotlib/pull/12216
X: @github
Domain: github.com
| route-pattern | /:user_id/:repository/pull/:id/files(.:format) |
| route-controller | pull_requests |
| route-action | files |
| fetch-nonce | v2:12cbae95-8331-6244-4351-eff2ea780782 |
| current-catalog-service-hash | ae870bc5e265a340912cde392f23dad3671a0a881730ffdadd82f2f57d81641b |
| request-id | D964:17E75B:1673B1:1DF8BA:6A56F651 |
| html-safe-nonce | 0f867dfa51b6abb8d9f0aeaaae252f84f95fa7a6ee78f1895aefabaf354fbeb4 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJEOTY0OjE3RTc1QjoxNjczQjE6MURGOEJBOjZBNTZGNjUxIiwidmlzaXRvcl9pZCI6IjE4MzM4MTM2MTU0MDI0ODEyMzMiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ== |
| visitor-hmac | ebc9c5f6c8945768335de58cf992d46e232b510551d333ec843a1b9caeb88335 |
| hovercard-subject-tag | pull_request:217475582 |
| github-keyboard-shortcuts | repository,pull-request-list,pull-request-conversation,pull-request-files-changed,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/matplotlib/matplotlib/pull/12216/files |
| twitter:image | https://avatars.githubusercontent.com/u/23121882?s=400&v=4 |
| twitter:card | summary_large_image |
| og:image | https://avatars.githubusercontent.com/u/23121882?s=400&v=4 |
| og:image:alt | PR Summary Sphinx 1.8 broke the matplolib search as seen in #12183. The issue is sphinx-doc/sphinx#5460 but it will not be fixed from the sphinx side. Instead they propose a solution as seen in rea... |
| og:site_name | GitHub |
| og:type | object |
| hostname | github.com |
| expected-hostname | github.com |
| None | 4eb29e5f807bd95e41196adfbc6d28f9af12d89830d8b684f3e871774ddff2fc |
| turbo-cache-control | no-preview |
| diff-view | unified |
| go-import | github.com/matplotlib/matplotlib git https://github.com/matplotlib/matplotlib.git |
| octolytics-dimension-user_id | 215947 |
| octolytics-dimension-user_login | matplotlib |
| octolytics-dimension-repository_id | 1385122 |
| octolytics-dimension-repository_nwo | matplotlib/matplotlib |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 1385122 |
| octolytics-dimension-repository_network_root_nwo | matplotlib/matplotlib |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | true |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | b056788a129fb0194b61f2ebb4c43f6a9f4dfd27 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width