Title: feat(plot_directive): add RST directory option by jeertmans · Pull Request #26099 · matplotlib/matplotlib · GitHub
Open Graph Title: feat(plot_directive): add RST directory option by jeertmans · Pull Request #26099 · matplotlib/matplotlib
X Title: feat(plot_directive): add RST directory option by jeertmans · Pull Request #26099 · matplotlib/matplotlib
Description: Hello! PR summary After trying to set up my own documentation, I had trouble making the plot_directive work with the autodoc2 extension. autodoc2 is unlike sphinx.ext.autodoc because it automatically generates all RST files, at a place that is not the same where we would usually call autodoc's directives. To cope with this problem, I had to implement my own Sphinx directive, based on yours. This may not be the perfect solution, but it works fine. Feel free to suggest any change :-) If you want to see a live example of this, here is the repo I developed the solution for: https://github.com/jeertmans/DiffeRT2d. This example plot is available here: http://eertmans.be/DiffeRT2d/apidocs/differt2d/differt2d.scene.html#differt2d.scene.Scene.basic_scene. EDIT: documentation examples are no longer online, but you may see the repository at the specific version the error was found. PR checklist [N/A] "closes #0000" is in the body of the PR description to link the related issue [N/A] new and changed code is tested [N/A] Plotting related features are demonstrated in an example [N/A] New Features and API Changes are noted with a directive and release note Documentation complies with general and docstring guidelines
Open Graph Description: Hello! PR summary After trying to set up my own documentation, I had trouble making the plot_directive work with the autodoc2 extension. autodoc2 is unlike sphinx.ext.autodoc because it automatical...
X Description: Hello! PR summary After trying to set up my own documentation, I had trouble making the plot_directive work with the autodoc2 extension. autodoc2 is unlike sphinx.ext.autodoc because it automatical...
Opengraph URL: https://github.com/matplotlib/matplotlib/pull/26099
X: @github
Domain: github.com
| route-pattern | /:user_id/:repository/pull/:id/files(.:format) |
| route-controller | pull_requests |
| route-action | files |
| fetch-nonce | v2:65ef733f-db98-3846-17b4-488bc11f9e44 |
| current-catalog-service-hash | ae870bc5e265a340912cde392f23dad3671a0a881730ffdadd82f2f57d81641b |
| request-id | D06E:6CD0B:83637:B315E:6A536400 |
| html-safe-nonce | 2e3aa03ae673b05d4961d87b763eb88b9d10bbb4ce20c31db52d504bc4e561fd |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJEMDZFOjZDRDBCOjgzNjM3OkIzMTVFOjZBNTM2NDAwIiwidmlzaXRvcl9pZCI6IjUzMzk3ODE0NTYxODgzNjc4NzIiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ== |
| visitor-hmac | 246fc98e7224af9546f9a43e82a52c8c748666b3b3b50da4f76aae72d9063396 |
| hovercard-subject-tag | pull_request:1386325326 |
| 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/26099/files |
| twitter:image | https://avatars.githubusercontent.com/u/27275099?s=400&v=4 |
| twitter:card | summary_large_image |
| og:image | https://avatars.githubusercontent.com/u/27275099?s=400&v=4 |
| og:image:alt | Hello! PR summary After trying to set up my own documentation, I had trouble making the plot_directive work with the autodoc2 extension. autodoc2 is unlike sphinx.ext.autodoc because it automatical... |
| 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 |
| disable-turbo | true |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 07a982c1d40157c619b364352b704c3ce66bb332 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width