Title: DOC: Suppress IPython output in examples and tutorials where not needed by StefRe · Pull Request #23978 · matplotlib/matplotlib · GitHub
Open Graph Title: DOC: Suppress IPython output in examples and tutorials where not needed by StefRe · Pull Request #23978 · matplotlib/matplotlib
X Title: DOC: Suppress IPython output in examples and tutorials where not needed by StefRe · Pull Request #23978 · matplotlib/matplotlib
Description: PR Summary By default, sphinx-gallery captures the last output of each code block and shows it in the generated html in yellow boxes. Especially in tutorials with frequently interleaving code and text blocks this may appear confusing and reduces readability. In some cases, however, the output is desired (although it could always be replaced by printing). The global configuration is now changed to "capture nothing", for one tutorial with multiple desired outputs this is overridden in the file to show the output and in other cases with just one desired output it's converted to a call to print(). (I went through all the examples and tutorials by searching the generated rst files for .. rst-class:: sphx-glr-script-out to see if we need the generated output, hopefully I didn't overlook some desired output) This PR addresses this #21794 (comment): I won't object if someone has a way to suppress these via configuration. However, note that some of our examples want the output to show up, so it can't be global. PR Checklist Tests and Styling [N/A] Has pytest style unit tests (and pytest passes). [N/A] Is Flake 8 compliant (install flake8-docstrings and run flake8 --docstring-convention=all). Documentation [N/A] New features are documented, with examples if plot related. [N/A] New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there). [N/A] API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there). Documentation is sphinx and numpydoc compliant (the docs should build without error).
Open Graph Description: PR Summary By default, sphinx-gallery captures the last output of each code block and shows it in the generated html in yellow boxes. Especially in tutorials with frequently interleaving code and t...
X Description: PR Summary By default, sphinx-gallery captures the last output of each code block and shows it in the generated html in yellow boxes. Especially in tutorials with frequently interleaving code and t...
Opengraph URL: https://github.com/matplotlib/matplotlib/pull/23978
X: @github
Domain: github.com
| route-pattern | /:user_id/:repository/pull/:id/files(.:format) |
| route-controller | pull_requests |
| route-action | files |
| fetch-nonce | v2:3c8e8c92-47ea-6fd7-d3ff-40676604a7e4 |
| current-catalog-service-hash | ae870bc5e265a340912cde392f23dad3671a0a881730ffdadd82f2f57d81641b |
| request-id | 952A:28B9FB:25A10B4:358A58A:6A50F944 |
| html-safe-nonce | 2080ca72901cab5429adf64629dcf61531ffd2cba241c094e120ce46f88f7228 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI5NTJBOjI4QjlGQjoyNUExMEI0OjM1OEE1OEE6NkE1MEY5NDQiLCJ2aXNpdG9yX2lkIjoiNzc2NjIyMzg4Mjg5ODQzODQ2OCIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9 |
| visitor-hmac | 3542e6d7d1c7a0c3d2d4dca3f75c34caf246d8f957d53dbcc1ef817dd6885fd6 |
| hovercard-subject-tag | pull_request:1063096250 |
| 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/23978/files |
| twitter:image | https://avatars.githubusercontent.com/u/19879328?s=400&v=4 |
| twitter:card | summary_large_image |
| og:image | https://avatars.githubusercontent.com/u/19879328?s=400&v=4 |
| og:image:alt | PR Summary By default, sphinx-gallery captures the last output of each code block and shows it in the generated html in yellow boxes. Especially in tutorials with frequently interleaving code and t... |
| og:site_name | GitHub |
| og:type | object |
| hostname | github.com |
| expected-hostname | github.com |
| None | 5266e58c17a510c403505cc811606465e90a881d2007ee7df1c4800d5c659838 |
| 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 full-width |
| disable-turbo | true |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 8d836581d020676cc0ef4a83cd2fe17e4af02c3d |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width