👌 IMPROVE: Allow heading_slug_func to be a string #696
Conversation
This file contains 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
Codecov ReportBase: 89.72% // Head: 89.67% // Decreases project coverage by
Additional details and impacted files@@ Coverage Diff @@
## master #696 +/- ##
==========================================
- Coverage 89.72% 89.67% -0.06%
==========================================
Files 22 22
Lines 2658 2674 +16
==========================================
+ Hits 2385 2398 +13
- Misses 273 276 +3
Flags with carried forward coverage won't be shown. Click here to find out more.
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
`myst_heading_slug_func` can now also be set to a string, which will be interpreted as an import path to a function, e.g. `myst_heading_slug_func = "mypackage.mymodule.slugify"`.
chrisjsewell
force-pushed
the
heading_slug_func_str
branch
from
d067de5 to
eb655a5
Compare
Alexey-NM
reviewed
Feb 13, 2023
| `myst_heading_slug_func` can now also be set to a string, | ||
| which will be interpreted as an import path to a function, | ||
| e.g. `myst_heading_slug_func = "mypackage.mymodule.slugify"`. | ||
| ::: |
There was a problem hiding this comment.
Greate change, thank you.
I think it would be better to add an advice. Something like:
You should set this parameter as string to avoid unnecessary rebuild of a project.
It will save a lot of time for other people.
slinder1
added a commit
to slinder1/llvm-project
that referenced
this pull request
Aug 19, 2024
Avoid creating an uncacheable conf variable by using a string instead of a function reference. Also has the effect of avoiding triggering the "config.cache" sphinx warning. Requires myst_parser 0.19.0 (specifically executablebooks/MyST-Parser#696) which is over a year old by now. Do we mandate any minimum version for these dependencies?
slinder1
added a commit
to llvm/llvm-project
that referenced
this pull request
Sep 3, 2024
Avoid creating an uncacheable conf variable by using a string instead of a function reference. Also has the effect of avoiding triggering the "config.cache" sphinx warning. Requires myst_parser 0.19.0 (specifically executablebooks/MyST-Parser#696) which is over a year old by now. Do we mandate any minimum version for these dependencies?
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.
myst_heading_slug_funccan now also be set to a string,which will be interpreted as an import path to a function,
e.g.
myst_heading_slug_func = "mypackage.mymodule.slugify".