MAINT Update backreferences docs and add tests#1154
MAINT Update backreferences docs and add tests#1154lucyleeow merged 10 commits intosphinx-gallery:masterfrom
Conversation
| 'prefer_full_module':[ | ||
| # a list of regex command of your module where the full module | ||
| # name should be used for sphinx_gallery instead of the shortend | ||
| 'yourmodule.*+\d{4}', |
There was a problem hiding this comment.
I was not sure exactly what this regex was intended to do, regex101 gave:
Have amended to just mod.submod as simple example.
larsoner
left a comment
There was a problem hiding this comment.
Feel free to merge when green
|
Thanks @larsoner, I had forgotten to push (so changes I mentioned were not up yet). If you're interested, would be good to get your eye over For posterity, the context here is that while I looked into our backreferences code during investigation of: napari/docs#214 and thought we could better test it. |
|
The backreferences code is always a bit of a nightmare. I usually rely on the tests being good enough to catch any breakages. We do check that some matplotlib things resolve in examples so hopefully it's good enough :( |
larsoner
left a comment
There was a problem hiding this comment.
Feel free to mark for merge-when-green if you're happy @lucyleeow !
… to version 0.14.0 v0.14.0 ------- **Implemented enhancements:** - MAINT Update backreferences docs and add tests `#1154 <https://github.com/sphinx-gallery/sphinx-gallery/pull/1154>`__ (`lucyleeow <https://github.com/lucyleeow>`__) - Remove extra spaces in reported running time `#1147 <https://github.com/sphinx-gallery/sphinx-gallery/pull/1147>`__ (`stefanv <https://github.com/stefanv>`__) **Fixed bugs:** - MAINT: Fix for Sphinx 7.2 `#1176 <https://github.com/sphinx-gallery/sphinx-gallery/pull/1176>`__ (`larsoner <https://github.com/larsoner>`__) - updated mpl gui warning catcher to new error message `#1160 <https://github.com/sphinx-gallery/sphinx-gallery/pull/1160>`__ (`story645 <https://github.com/story645>`__) - Ensure consistent encoding for md5sum generation `#1159 <https://github.com/sphinx-gallery/sphinx-gallery/pull/1159>`__ (`sdhiscocks <https://github.com/sdhiscocks>`__) - Maint: Fix ``app.builder.outdir`` as Sphinx now using pathlib `#1155 <https://github.com/sphinx-gallery/sphinx-gallery/pull/1155>`__ (`lucyleeow <https://github.com/lucyleeow>`__) - Make \_LoggingTee compatible with TextIO `#1151 <https://github.com/sphinx-gallery/sphinx-gallery/pull/1151>`__ (`o-laurent <https://github.com/o-laurent>`__) (NEWS truncated at 15 lines)
Fixes some nitpicks in backreferences docs.
Edit:
This PR now does the following:
SphinxDocLinkResolver.resolveprefer_full_moduleto set instead of list, like other similar configs (e.g., exclude_implicit_doc)prefer_full_module- gives you finer control and brings it in line with whatexclude_implicit_docdoes._get_short_module_name