Title: [Doc]: tutorials and user-doc organization... · Issue #24900 · matplotlib/matplotlib · GitHub
Open Graph Title: [Doc]: tutorials and user-doc organization... · Issue #24900 · matplotlib/matplotlib
X Title: [Doc]: tutorials and user-doc organization... · Issue #24900 · matplotlib/matplotlib
Description: The "tutorials" section of the docs is really mostly not a tutorial, but long-form discussion of library features, and how the library works. These are done using sphinx-gallery, which is quite convenient for writing docs with lots of pl...
Open Graph Description: The "tutorials" section of the docs is really mostly not a tutorial, but long-form discussion of library features, and how the library works. These are done using sphinx-gallery, which is quite con...
X Description: The "tutorials" section of the docs is really mostly not a tutorial, but long-form discussion of library features, and how the library works. These are done using sphinx-gallery, which is...
Opengraph URL: https://github.com/matplotlib/matplotlib/issues/24900
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"[Doc]: tutorials and user-doc organization...","articleBody":"The \"tutorials\" section of the docs is really mostly _not_ a tutorial, but long-form discussion of library features, and how the library works. These are done using sphinx-gallery, which is quite convenient for writing docs with lots of plotting examples in them. \r\n\r\nI would argue that much of the material in Tutorials should be considered part of the Users Guide, and organized in the TOC that way. It's possible some of the \"tutorials\" could just be made rst files, and edited in rst going froward. That would ideally require some sort of tool to \"run\" all the `.. plot::` directives in the rst without compiling the whole doc suite. Such a tool would be generally useful as well, and shouldn't be that hard to make. However, even leaving the \"tutorials\" as sphinx-gallery python files may be fine if we organize them in the User Guide TOC.\r\n\r\n","author":{"url":"https://github.com/jklymak","@type":"Person","name":"jklymak"},"datePublished":"2023-01-06T20:58:24.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":2},"url":"https://github.com/24900/matplotlib/issues/24900"}
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:97277dc8-25ea-e683-8729-89d0a8136ef2 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | DBC6:F5E51:A8859EC:ABEED59:6A50B1D4 |
| html-safe-nonce | 0f724e61b18f4f31beac878c2053e87e963ebe29236bec40971f94515cadc496 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJEQkM2OkY1RTUxOkE4ODU5RUM6QUJFRUQ1OTo2QTUwQjFENCIsInZpc2l0b3JfaWQiOiI0MjY2MTU2NjM5OTgyMjM2MTE2IiwicmVnaW9uX2VkZ2UiOiJzZWEiLCJyZWdpb25fcmVuZGVyIjoic2VhIn0= |
| visitor-hmac | a7b62b54ca22843c0521ac80a5bb04fd837caf9e652df8ee929b64d9949911c9 |
| hovercard-subject-tag | issue:1523158150 |
| github-keyboard-shortcuts | repository,issues,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/_view_fragments/issues/show/matplotlib/matplotlib/24900/issue_layout |
| twitter:image | https://opengraph.githubassets.com/ce1f4bf5a9f81d3b69c7f81103ab12caf606a5eccddde1cf2c048e0dbb6e317b/matplotlib/matplotlib/issues/24900 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/ce1f4bf5a9f81d3b69c7f81103ab12caf606a5eccddde1cf2c048e0dbb6e317b/matplotlib/matplotlib/issues/24900 |
| og:image:alt | The "tutorials" section of the docs is really mostly not a tutorial, but long-form discussion of library features, and how the library works. These are done using sphinx-gallery, which is quite con... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | jklymak |
| hostname | github.com |
| expected-hostname | github.com |
| None | 63772747707af4093f0d5fc7aa1bb3bb55f412a9865207c4f421aa34c64cc404 |
| turbo-cache-control | no-preview |
| 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 | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | ded53fe94e3ff1bb4dbf8cc77e285396c92580fb |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width