Skip to content

Commit 18cf14e

Browse files
committed
[Docs] Use cacheable myst_heading_slug_func value
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?
1 parent db8ca88 commit 18cf14e

File tree

2 files changed

+2
-6
lines changed

2 files changed

+2
-6
lines changed

lldb/docs/conf.py

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -57,10 +57,8 @@
5757
raise
5858

5959
# Automatic anchors for markdown titles
60-
from llvm_slug import make_slug
61-
6260
myst_heading_anchors = 6
63-
myst_heading_slug_func = make_slug
61+
myst_heading_slug_func = "llvm_slug.make_slug"
6462

6563
autodoc_default_options = {"special-members": True}
6664

llvm/docs/conf.py

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,8 @@
4040
raise
4141

4242
# Automatic anchors for markdown titles
43-
from llvm_slug import make_slug
44-
4543
myst_heading_anchors = 6
46-
myst_heading_slug_func = make_slug
44+
myst_heading_slug_func = "llvm_slug.make_slug"
4745

4846

4947
# Add any paths that contain templates here, relative to this directory.

0 commit comments

Comments
 (0)