Title: Doc: doc docs reorg by story645 · Pull Request #28578 · matplotlib/matplotlib · GitHub
Open Graph Title: Doc: doc docs reorg by story645 · Pull Request #28578 · matplotlib/matplotlib
X Title: Doc: doc docs reorg by story645 · Pull Request #28578 · matplotlib/matplotlib
Description: PR summary Feedback at sprints was that it's kinda confusing to have the doc build docs meshed w/ the doc formatting docs, so: pulled em out into their own page once I was writing new pages, moved all the docs pages so that they have document-* as a prefix so it's easier to identify which dev docs are doc docs -> my bias would be to move em into a docs docs folder, but 🤷♀️ if the preference is for flat structure. Note: looking at this now, probably the cleanest split is build instructions writing instructions apply to ALL docs -> .rst formatting guidance, style etc writing instructions that apply to specific docs -> how to write examples, how to write docstrings, etc tagging can remain top level or go under "specific docs" This is part of #26392 and #26196. Follow up would be: clean up the build instructions w/ tables and tabs so it's easier to find specific information separate all the "how to write .rst"/applies to all docs content into the format page, doc type specific guidance into content/style page. attn: @juanis2112 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: PR summary Feedback at sprints was that it's kinda confusing to have the doc build docs meshed w/ the doc formatting docs, so: pulled em out into their own page once I was writing new pages, ...
X Description: PR summary Feedback at sprints was that it's kinda confusing to have the doc build docs meshed w/ the doc formatting docs, so: pulled em out into their own page once I was writing new pag...
Opengraph URL: https://github.com/matplotlib/matplotlib/pull/28578
X: @github
Domain: github.com
| route-pattern | /:user_id/:repository/pull/:id/files(.:format) |
| route-controller | pull_requests |
| route-action | files |
| fetch-nonce | v2:a4326bf1-e57f-45f1-dc26-82a0566c2882 |
| current-catalog-service-hash | ae870bc5e265a340912cde392f23dad3671a0a881730ffdadd82f2f57d81641b |
| request-id | D7F0:2D857A:9CDB10:D35939:6A5312DD |
| html-safe-nonce | 89cb999d706ee63694e3364e34fedf85d97ec0819dee8089606b0db42c88ce70 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJEN0YwOjJEODU3QTo5Q0RCMTA6RDM1OTM5OjZBNTMxMkREIiwidmlzaXRvcl9pZCI6IjkxMTMwODYzMjI1NTMwNDQxMyIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9 |
| visitor-hmac | e16620d5b4ee75aef8161b61189acd15185f691e3b1f19dfbbc7ced8c40e2659 |
| hovercard-subject-tag | pull_request:1968646800 |
| 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/28578/files |
| twitter:image | https://avatars.githubusercontent.com/u/1300499?s=400&v=4 |
| twitter:card | summary_large_image |
| og:image | https://avatars.githubusercontent.com/u/1300499?s=400&v=4 |
| og:image:alt | PR summary Feedback at sprints was that it's kinda confusing to have the doc build docs meshed w/ the doc formatting docs, so: pulled em out into their own page once I was writing new pages, ... |
| 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 | canary-1 |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width