summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJason Yundt <jason@jasonyundt.email>2022-09-12 15:51:39 -0400
committerJason Yundt <jason@jasonyundt.email>2022-09-12 15:51:39 -0400
commit7f30e81abecd28030775931ea4bdfce45b199390 (patch)
treeb1f3597ed63f33b51d38cf3aafb5efc42e413401
parent79b21e96ad7a154e6c64a88150c98bd4dea52e91 (diff)
Fix invalid literals in generated rst docs
Before this change, API docs that look like this: …adding [param character]s to the right of the string. would turn into rst files that look like this: …adding ``character``s to the right of the string. That reStructuredText is invalid and causes warnings when the docs repo is built.
-rwxr-xr-xdoc/tools/make_rst.py2
1 files changed, 2 insertions, 0 deletions
diff --git a/doc/tools/make_rst.py b/doc/tools/make_rst.py
index cd7de085d8..a8569413ec 100755
--- a/doc/tools/make_rst.py
+++ b/doc/tools/make_rst.py
@@ -1480,6 +1480,8 @@ def format_text_block(
)
tag_text = f"``{link_target}``"
+ escape_pre = True
+ escape_post = True
# Formatting directives.