Skip to content

FIX: Fix stability of stored compiled regex#1369

Merged
lucyleeow merged 1 commit intosphinx-gallery:masterfrom
larsoner:stable
Aug 6, 2024
Merged

FIX: Fix stability of stored compiled regex#1369
lucyleeow merged 1 commit intosphinx-gallery:masterfrom
larsoner:stable

Conversation

@larsoner
Copy link
Copy Markdown
Contributor

@larsoner larsoner commented Aug 6, 2024

I couldn't figure out why my MNE doc build was always rebuilding. It's because the re.compile(<str>.join(<set>)) will not have a stable repr run-to-run because set does not have a stable order run-to-run. This PR fixes it. Not easy to add a test because it would require invoking sphinx twice, and even then would be a Heisenbug to detect. Hopefully sphinx-doc/sphinx#12741 can move forward to make this more easy to detect.

@larsoner larsoner added the bug label Aug 6, 2024
@lucyleeow lucyleeow merged commit 3fce549 into sphinx-gallery:master Aug 6, 2024
@lucyleeow
Copy link
Copy Markdown
Contributor

Thanks @larsoner

@larsoner larsoner deleted the stable branch August 6, 2024 23:55
@lucyleeow
Copy link
Copy Markdown
Contributor

@larsoner I think I'll release now, unless there are any more bug fixes coming? 😁

@larsoner
Copy link
Copy Markdown
Contributor Author

larsoner commented Aug 7, 2024

Go for it!

clrpackages referenced this pull request in clearlinux-pkgs/pypi-sphinx_gallery Aug 9, 2024
… to version 0.17.1

v0.17.1
-------

**Fixed bugs:**

-  FIX: Fix stability of stored compiled regex `#1369 <https://github.com/sphinx-gallery/sphinx-gallery/pull/1369>`__ (`larsoner <https://github.com/larsoner>`__)
-  ENH: Improve \_sanitize_rst `#1366 <https://github.com/sphinx-gallery/sphinx-gallery/pull/1366>`__ (`timhoffm <https://github.com/timhoffm>`__)
-  Obey prefer_full_module setting when finding backreferences `#1364 <https://github.com/sphinx-gallery/sphinx-gallery/pull/1364>`__ (`QuLogic <https://github.com/QuLogic>`__)
-  Fix linking to class attributes with prefer_full_module `#1363 <https://github.com/sphinx-gallery/sphinx-gallery/pull/1363>`__ (`QuLogic <https://github.com/QuLogic>`__)
-  Improve minigallery directive path input resolution `#1360 <https://github.com/sphinx-gallery/sphinx-gallery/pull/1360>`__ (`lucyleeow <https://github.com/lucyleeow>`__)
-  FIX Allow str path minigallery entries when backreferences off `#1355 <https://github.com/sphinx-gallery/sphinx-gallery/pull/1355>`__ (`lucyleeow <https://github.com/lucyleeow>`__)
-  FIX generate zipfiles when index passed by user `#1353 <https://github.com/sphinx-gallery/sphinx-gallery/pull/1353>`__ (`lucyleeow <https://github.com/lucyleeow>`__)

**Documentation**

(NEWS truncated at 15 lines)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants