Title: DOC/BUILD add ability for conf to skip whole sections by jklymak · Pull Request #24907 · matplotlib/matplotlib · GitHub
Open Graph Title: DOC/BUILD add ability for conf to skip whole sections by jklymak · Pull Request #24907 · matplotlib/matplotlib
X Title: DOC/BUILD add ability for conf to skip whole sections by jklymak · Pull Request #24907 · matplotlib/matplotlib
Description: PR Summary UPDATE: 11 Jan: The doc build is painfully slow. This gives devs an easy way to populate exclude_patterns in conf.py with subdirectories they do not want while they are doing development, and to not do the gallery builds if those subdirectories are excluded. Of course the resulting build is broken with dropped references etc, so the developer should put conf.py back to its pristine state, but this should be a handy tool. Note to build just the user subdirectory using this takes 5s on my machine (if I exclude the prev_whats_new). Closes #24906 Behaviour: The interface is make html-skip-subdirs which calls $(SPHINXBUILD) -D skip_sub_dirs=1 -b html .... It tries to read doc/.mpl_skip_subdirs.yaml. If that does not exist, that file is created and looks like: comment: For use with make html-skip-subdirs skip_subdirs: - users/prev_whats_new/* - api/* - gallery/* - tutorials/* - plot_types/* - devel/* If all of gallery/* (etc) is skipped, then sphinx-gallery does not get run on that subdirectory. OTOH if only subdirectories of it are skipped, then the whole gallery is run (only once though, if gallery not previously generated). With the above default the users/* directory is built in 5 seconds on my machine, in contrast to the full doc build that takes upwards of 10 minutes. PR Checklist Documentation and Tests Has pytest style unit tests (and pytest passes) Documentation is sphinx and numpydoc compliant (the docs should build without error). New plotting related features are documented with examples. Release Notes New features are marked with a .. versionadded:: directive in the docstring and documented in doc/users/next_whats_new/ API changes are marked with a .. versionchanged:: directive in the docstring and documented in doc/api/next_api_changes/ Release notes conform with instructions in next_whats_new/README.rst or next_api_changes/README.rst
Open Graph Description: PR Summary UPDATE: 11 Jan: The doc build is painfully slow. This gives devs an easy way to populate exclude_patterns in conf.py with subdirectories they do not want while they are doing developmen...
X Description: PR Summary UPDATE: 11 Jan: The doc build is painfully slow. This gives devs an easy way to populate exclude_patterns in conf.py with subdirectories they do not want while they are doing developmen...
Opengraph URL: https://github.com/matplotlib/matplotlib/pull/24907
X: @github
Domain: github.com
| route-pattern | /:user_id/:repository/pull/:id/files(.:format) |
| route-controller | pull_requests |
| route-action | files |
| fetch-nonce | v2:668ca022-abf8-6bb8-37c5-4b528c1b41be |
| current-catalog-service-hash | ae870bc5e265a340912cde392f23dad3671a0a881730ffdadd82f2f57d81641b |
| request-id | C402:24C5C6:1A64A80:230AE4C:6A51D444 |
| html-safe-nonce | e0faeff4184ac2814d2a2c0c120c642b666ee5b5244a921f2e04798f955633d2 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJDNDAyOjI0QzVDNjoxQTY0QTgwOjIzMEFFNEM6NkE1MUQ0NDQiLCJ2aXNpdG9yX2lkIjoiOTE0NzEyMzIxMzY0OTY5NTgxMyIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9 |
| visitor-hmac | 0d26d23efbef4dc7bd42d33fc6866adeb3b099b71f60164406f51918564851b0 |
| hovercard-subject-tag | pull_request:1189696377 |
| 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/24907/files |
| twitter:image | https://avatars.githubusercontent.com/u/1562854?s=400&v=4 |
| twitter:card | summary_large_image |
| og:image | https://avatars.githubusercontent.com/u/1562854?s=400&v=4 |
| og:image:alt | PR Summary UPDATE: 11 Jan: The doc build is painfully slow. This gives devs an easy way to populate exclude_patterns in conf.py with subdirectories they do not want while they are doing developmen... |
| 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 | 7aed05249554b889eb33d002851a973eebcc7e91 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width