diff options
Diffstat (limited to 'doc/tools/make_rst.py')
| -rwxr-xr-x | doc/tools/make_rst.py | 27 |
1 files changed, 11 insertions, 16 deletions
diff --git a/doc/tools/make_rst.py b/doc/tools/make_rst.py index 6a99bfbe06..c3a21f3d7b 100755 --- a/doc/tools/make_rst.py +++ b/doc/tools/make_rst.py @@ -1361,7 +1361,7 @@ def make_enum(t: str, is_bitfield: bool, state: State) -> str: if is_bitfield: if not state.classes[c].enums[e].is_bitfield: print_error(f'{state.current_class}.xml: Enum "{t}" is not bitfield.', state) - return f"|bitfield|\<:ref:`{e}<enum_{c}_{e}>`\>" + return f"|bitfield|\\<:ref:`{e}<enum_{c}_{e}>`\\>" else: return f":ref:`{e}<enum_{c}_{e}>`" @@ -1552,16 +1552,11 @@ def make_rst_index(grouped_classes: Dict[str, List[str]], dry_run: bool, output_ f.write(".. _doc_class_reference:\n\n") - main_title = translate("All classes") - f.write(f"{main_title}\n") - f.write(f"{'=' * len(main_title)}\n\n") + f.write(make_heading("All classes", "=")) for group_name in CLASS_GROUPS: if group_name in grouped_classes: - group_title = translate(CLASS_GROUPS[group_name]) - - f.write(f"{group_title}\n") - f.write(f"{'=' * len(group_title)}\n\n") + f.write(make_heading(CLASS_GROUPS[group_name], "=")) f.write(".. toctree::\n") f.write(" :maxdepth: 1\n") @@ -2082,9 +2077,9 @@ def format_text_block( post_text = text[endurl_pos + 6 :] if pre_text and pre_text[-1] not in MARKUP_ALLOWED_PRECEDENT: - pre_text += "\ " + pre_text += "\\ " if post_text and post_text[0] not in MARKUP_ALLOWED_SUBSEQUENT: - post_text = "\ " + post_text + post_text = "\\ " + post_text text = pre_text + tag_text + post_text pos = len(pre_text) + len(tag_text) @@ -2162,9 +2157,9 @@ def format_text_block( # Properly escape things like `[Node]s` if escape_pre and pre_text and pre_text[-1] not in MARKUP_ALLOWED_PRECEDENT: - pre_text += "\ " + pre_text += "\\ " if escape_post and post_text and post_text[0] not in MARKUP_ALLOWED_SUBSEQUENT: - post_text = "\ " + post_text + post_text = "\\ " + post_text next_brac_pos = post_text.find("[", 0) iter_pos = 0 @@ -2172,7 +2167,7 @@ def format_text_block( iter_pos = post_text.find("*", iter_pos, next_brac_pos) if iter_pos == -1: break - post_text = f"{post_text[:iter_pos]}\*{post_text[iter_pos + 1 :]}" + post_text = f"{post_text[:iter_pos]}\\*{post_text[iter_pos + 1 :]}" iter_pos += 2 iter_pos = 0 @@ -2181,7 +2176,7 @@ def format_text_block( if iter_pos == -1: break if not post_text[iter_pos + 1].isalnum(): # don't escape within a snake_case word - post_text = f"{post_text[:iter_pos]}\_{post_text[iter_pos + 1 :]}" + post_text = f"{post_text[:iter_pos]}\\_{post_text[iter_pos + 1 :]}" iter_pos += 2 else: iter_pos += 1 @@ -2222,7 +2217,7 @@ def escape_rst(text: str, until_pos: int = -1) -> str: pos = text.find("*", pos, until_pos) if pos == -1: break - text = f"{text[:pos]}\*{text[pos + 1 :]}" + text = f"{text[:pos]}\\*{text[pos + 1 :]}" pos += 2 # Escape _ character at the end of a word to avoid interpreting it as an inline hyperlink @@ -2232,7 +2227,7 @@ def escape_rst(text: str, until_pos: int = -1) -> str: if pos == -1: break if not text[pos + 1].isalnum(): # don't escape within a snake_case word - text = f"{text[:pos]}\_{text[pos + 1 :]}" + text = f"{text[:pos]}\\_{text[pos + 1 :]}" pos += 2 else: pos += 1 |