DOC: omit basic_units helper from gallery#31909
Conversation
|
Thank you for opening your first PR into Matplotlib! If you have not heard from us in a week or so, please leave a new comment below and that should bring it to our attention. Most of our reviewers are volunteers and sometimes things fall through the cracks. We also ask that you please finish addressing any review comments on this PR and wait for it to be merged (or closed) before opening a new one, as it can be a valuable learning experience to go through the review process. You can also join us on discourse chat for real-time discussion. For details on testing, writing docs, and our review process, please see the developer guide. We strive to be a welcoming and open project. Please follow our Code of Conduct. |
DOC: omit basic_units helper from gallery
PR summary
This PR prevents
galleries/examples/units/basic_units.pyfrom being rendered as a standalone gallery page. The file is a helper module used by the units examples, not a visual gallery example, and issue #17479 notes that it should likely be omitted from the gallery listing.The file is still copied into the generated gallery output via
copyfile_regex, so existing examples can continue to import it and users can still download it from links such as:download:\basic_units.py <basic_units.py>``.Addresses one item from #17479.
AI Disclosure
I used Codex to inspect the issue, read the repository documentation, identify the smallest scoped change, and run local checks. I reviewed the resulting configuration change and verified the regex behavior locally.
PR checklist
Testing
git diff --checkpython -m py_compile doc/conf.py../galleries/examples/units/basic_units.pymatchesignore_pattern../galleries/examples/units/basic_units.pymatchescopyfile_regex.rstfiles still matchcopyfile_regex.pyfiles such asbar_unit_demo.pydo not match either ruleFull documentation build was not run locally because this environment does not have Matplotlib's documentation dependencies installed, including
sphinx_gallery.