Title: Resurrecting axes_grid1 documentation by ImportanceOfBeingErnest · Pull Request #11079 · matplotlib/matplotlib · GitHub
Open Graph Title: Resurrecting axes_grid1 documentation by ImportanceOfBeingErnest · Pull Request #11079 · matplotlib/matplotlib
X Title: Resurrecting axes_grid1 documentation by ImportanceOfBeingErnest · Pull Request #11079 · matplotlib/matplotlib
Description: PR Summary This is an attempt to resurrect the axes_grid1 and axisartist documentation. Those are not present in the current docs, see #9582 The strategy here is to move stuff from doc/mpl_toolkits/ → doc/api/toolkits and create a toc for both modules. Then, a lot of broken links need to be replaced. Currently this still fails due to mpl_toolkits.axes_grid1.colorbar.colorbar not producing a valid docstring. There are also a couple of missing files which should be produced by sphinx-gallery, but are not for some reason. (solved) I will try to include the make.bat into this PR without -W flag, such that the tests can hopefully build the docs and people can look at the produced errors. (solved) The general idea here would be: create a working documentation for axisartist and axes_grid1 inside of doc/api/toolkits first. As can be seen, this is unproblematic in general, but causes some trouble with broken docstrings and missing files etc. Those have now been solved. In particular: problematic links have been replaced by the full version (~matplotlib.axes.Axes instead of .Axes) classes for which no examples are created by sphinx-gallery (sphinx-gallery/sphinx-gallery#365) are excluded inside the template. The offending colorbar vs Colorbar issue (sphinx-doc/sphinx#4874) has been worked around by using a different template for this special case. Now that those problems are solved and a valid documentation can be built, one may in a next step move it outside of doc/api - in case this is still desired. (I didn't manage to do this, so I would propose to do this in a new PR if someone has a solution to that). PR Checklist Code is PEP 8 compliant Documentation is sphinx and numpydoc compliant
Open Graph Description: PR Summary This is an attempt to resurrect the axes_grid1 and axisartist documentation. Those are not present in the current docs, see #9582 The strategy here is to move stuff from doc/mpl_toolkits...
X Description: PR Summary This is an attempt to resurrect the axes_grid1 and axisartist documentation. Those are not present in the current docs, see #9582 The strategy here is to move stuff from doc/mpl_toolkits...
Opengraph URL: https://github.com/matplotlib/matplotlib/pull/11079
X: @github
Domain: github.com
| route-pattern | /:user_id/:repository/pull/:id/files(.:format) |
| route-controller | pull_requests |
| route-action | files |
| fetch-nonce | v2:a886fdc2-a97e-4dfc-cead-54fb28008aed |
| current-catalog-service-hash | ae870bc5e265a340912cde392f23dad3671a0a881730ffdadd82f2f57d81641b |
| request-id | D0A6:108FC:2BBF304:3AEE4C4:6A53B387 |
| html-safe-nonce | b84c99d4e912fc379df999011d81dc88ea9c1c697b7378ce8b6d96cc789f8746 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJEMEE2OjEwOEZDOjJCQkYzMDQ6M0FFRTRDNDo2QTUzQjM4NyIsInZpc2l0b3JfaWQiOiIxMzkwNzE0NzcxNjIwNDc1NzgzIiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0= |
| visitor-hmac | 979b723ac62f551ec2906cac280e71141ffa4d671b662c2896aae92419b4befd |
| hovercard-subject-tag | pull_request:182532655 |
| 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/11079/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 This is an attempt to resurrect the axes_grid1 and axisartist documentation. Those are not present in the current docs, see #9582 The strategy here is to move stuff from doc/mpl_toolkits... |
| 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 | 07a982c1d40157c619b364352b704c3ce66bb332 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width