ENH: Improve _sanitize_rst #1366
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
When using the sphinx config `default_role = 'obj'`, one can leave out the prefixes :meth: and similar and directly reference code objects using backticks. In there, one can use the sphinx prefix modifiers `.` and `~`. This PR enhances `_sanitize_rst` to remove the prefix modifiers: - `.MyClass` --> MyClass - `~.MyClass.close` --> close
larsoner
approved these changes
Aug 3, 2024
|
Thanks @timhoffm ! |
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 721D 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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When using the sphinx config
default_role = 'obj', one can leave out the prefixes :meth: and similar and directly reference code objects using backticks. In there, one can use the sphinx prefix modifiers.and~.Examples from Matplotlib where these show up:
This PR enhances
_sanitize_rstto remove the prefix modifiers:.MyClass--> MyClass~.MyClass.close--> close