Title: [MNT]: Idea to accelerate docs contributions with `Build changes only docs`. · Issue #22956 · matplotlib/matplotlib · GitHub
Open Graph Title: [MNT]: Idea to accelerate docs contributions with `Build changes only docs`. · Issue #22956 · matplotlib/matplotlib
X Title: [MNT]: Idea to accelerate docs contributions with `Build changes only docs`. · Issue #22956 · matplotlib/matplotlib
Description: Summary Contributing small docs changes has one bottleneck in my perception: CircleCI takes LONG to build new changes in examples. When I execute the python script locally, it takes about 0.2 seconds. The CircleCI docs build takes more t...
Open Graph Description: Summary Contributing small docs changes has one bottleneck in my perception: CircleCI takes LONG to build new changes in examples. When I execute the python script locally, it takes about 0.2 secon...
X Description: Summary Contributing small docs changes has one bottleneck in my perception: CircleCI takes LONG to build new changes in examples. When I execute the python script locally, it takes about 0.2 secon...
Opengraph URL: https://github.com/matplotlib/matplotlib/issues/22956
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"[MNT]: Idea to accelerate docs contributions with `Build changes only docs`.","articleBody":"### Summary\r\n\r\nContributing small docs changes has one bottleneck in my perception: CircleCI takes LONG to build new changes in examples.\r\nWhen I execute the python script locally, it takes about 0.2 seconds.\r\nThe CircleCI docs build takes more than 30 minutes.\r\nI know that the sphinx rendering must also take some seconds, but it would be amazing if there was a way to bring the build time down to e.g. only 1 minute by only rendering relevant parts of the docs.\r\nThis could accelerate the review process a lot.\r\n\r\n### Proposed fix\r\n\r\nHere is an idea: Only nodes that connect to green lines are rendered, everything else is ignored.\r\n\u003cimg width=\"500\" alt=\"image\" src=\"https://user-images.githubusercontent.com/44469195/166198919-0213b8aa-1abf-4fd2-b71f-81d60b691faf.png\"\u003e\r\n\r\nIn a pull request, it can look like this: In every new commit, the (not yet existing?) GitHub action `Build changes only docs` is triggered.\r\nThis action will execute the above diagram.\r\n\r\nFor the current complete docs build with CircleCI, I see two options:\r\n1. It could be additional active all the time.\r\n2. It could be activated after the iteration phase in the last commit, to make sure that the whole docs build without error. This activation could be triggered e.g. when a pull request is getting the \"Approved\" status, or when there is a certain keyword in the commit. I would prefer the later one, as this saves resources.\r\n\r\nNote, that this is issue is not a Matplotlib specific, but also applies to other rendering intensive docs like `napari`, `manim` and `scikit-image`.","author":{"url":"https://github.com/kolibril13","@type":"Person","name":"kolibril13"},"datePublished":"2022-05-02T07:20:33.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":8},"url":"https://github.com/22956/matplotlib/issues/22956"}
| 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:b71640ec-9ef4-5a7a-2596-045dc8405f8d |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | AD5E:24C7F8:8FE909:C976A3:6A5394B0 |
| html-safe-nonce | d1f741ce79bc008609436ebd1ce57cc7d33ce281cd609c2a8daa37a5484839c8 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJBRDVFOjI0QzdGODo4RkU5MDk6Qzk3NkEzOjZBNTM5NEIwIiwidmlzaXRvcl9pZCI6IjI2Njk2MzY2ODgxMTMwMTM5MzYiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ== |
| visitor-hmac | 95f25c0e63c7ac61270b539be3b46b8468f5efa4ef7657847a9c152e4864176c |
| hovercard-subject-tag | issue:1222568998 |
| 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/22956/issue_layout |
| twitter:image | https://opengraph.githubassets.com/e4da74598fc94473e93c747c33b2da7211711526eab74760e548e6b447381c90/matplotlib/matplotlib/issues/22956 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/e4da74598fc94473e93c747c33b2da7211711526eab74760e548e6b447381c90/matplotlib/matplotlib/issues/22956 |
| og:image:alt | Summary Contributing small docs changes has one bottleneck in my perception: CircleCI takes LONG to build new changes in examples. When I execute the python script locally, it takes about 0.2 secon... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | kolibril13 |
| hostname | github.com |
| expected-hostname | github.com |
| None | b9a586c06a05a7a86fc7e3f4dbd03e42f6869085879aa184aa6369456dbd50fb |
| 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 | 07a982c1d40157c619b364352b704c3ce66bb332 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width