Title: sphinx-exhibit by anntzer · Pull Request #11936 · matplotlib/matplotlib · GitHub
Open Graph Title: sphinx-exhibit by anntzer · Pull Request #11936 · matplotlib/matplotlib
X Title: sphinx-exhibit by anntzer · Pull Request #11936 · matplotlib/matplotlib
Description: As hinted in a few other places in the issue tracker, I have been working on a new example runner for the docs. While it is still incomplete, I think I can now put up this PR to showcase some features. See https://3905-7439715-gh.circle-artifacts.com/0/home/circleci/project/doc/build/html/index.html for an example build. A (very) brief README for the sphinx extension (boringly named "sphinx-exhibit") is available at https://github.com/anntzer/sphinx-exhibit What works, especially in comparison with sphinx-gallery: Examples are run and doc pages generated (well, that's the base...). The links in the examples from the names to the corresponding API docs are much more complete than the ones generated by sphinx-gallery. This is because I actually introspect these while running the examples, so I can know that (e.g.) ax.plot is matplotlib.axes.Axes.plot. See e.g. the hillshading demo: Conversely, this allows backreferences to also be more complete: they now exist for methods too (see e.g. Axes.pcolorfast (at the very bottom) for something that doesn't have a corresponding function in pyplot). Notebooks are generated and have nicer markup, because we postprocess sphinx's HTML output, so all rst has been processed by sphinx already. Compare e.g. the links to ipython and pillow in the notebooks generated for the image demo by sphinx-gallery and by sphinx-exhibit (Yes, you notice the broken image link more in the latter, but note that the image is actually also missing in the former :)) I think the way to specify document order is nicer than for sphinx-gallery (see gallery/index.rst and tutorials/index.rst), although it is admittedly less general (could be improved). What remains to be done: Thumbnails are not generated (should be easy), and lists of links to examples are text-only (need to do some CSS wrangling to include the images). Note that sphinx-exhibit is not on PyPI (yet) so this build installs it from my github repo. Also, I use sphinx-jinja for templating (see doc/gallery/index.rst), but that project has a few bugs and my PRs are not getting merged (the project seems inactive), so I also install it from my repo (I may ultimately fork that project under a separate name if it remains inactive). (The sphinx-jinja manager merged my PRs and pushed a new version to PyPI, so things are fine now on this front.) Note that the first commit of this PR is #11931. attn @ImportanceOfBeingErnest @jklymak @timhoffm (who discussed this in #10974) and @choldgraf (as sphinx-gallery dev).
Open Graph Description: As hinted in a few other places in the issue tracker, I have been working on a new example runner for the docs. While it is still incomplete, I think I can now put up this PR to showcase some feat...
X Description: As hinted in a few other places in the issue tracker, I have been working on a new example runner for the docs. While it is still incomplete, I think I can now put up this PR to showcase some feat...
Opengraph URL: https://github.com/matplotlib/matplotlib/pull/11936
X: @github
Domain: github.com
| route-pattern | /:user_id/:repository/pull/:id/files(.:format) |
| route-controller | pull_requests |
| route-action | files |
| fetch-nonce | v2:e9986706-094a-973f-24b1-f2cb48fc1bfc |
| current-catalog-service-hash | ae870bc5e265a340912cde392f23dad3671a0a881730ffdadd82f2f57d81641b |
| request-id | AAE8:56830:152DA56:1BFA627:6A51BDAF |
| html-safe-nonce | ce32e35d7b37b8e0f8e0658025060cbfbf53dd61bbc344689a836f84c08ad34b |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJBQUU4OjU2ODMwOjE1MkRBNTY6MUJGQTYyNzo2QTUxQkRBRiIsInZpc2l0b3JfaWQiOiIyNzIxNjI5ODQ4NTA2MzE4MjU1IiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0= |
| visitor-hmac | 6ea046a85314cf7ac93f136492d60860415ff63b89981f2e1e616fdc53885579 |
| hovercard-subject-tag | pull_request:210912826 |
| 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/11936/files |
| twitter:image | https://avatars.githubusercontent.com/u/1322974?s=400&v=4 |
| twitter:card | summary_large_image |
| og:image | https://avatars.githubusercontent.com/u/1322974?s=400&v=4 |
| og:image:alt | As hinted in a few other places in the issue tracker, I have been working on a new example runner for the docs. While it is still incomplete, I think I can now put up this PR to showcase some feat... |
| og:site_name | GitHub |
| og:type | object |
| hostname | github.com |
| expected-hostname | github.com |
| None | b9a586c06a05a7a86fc7e3f4dbd03e42f6869085879aa184aa6369456dbd50fb |
| 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 | 7aed05249554b889eb33d002851a973eebcc7e91 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width