godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Documentation tool does not add escapes to code and codeblocks 

Instead of adding the escapes to all * and _ the tool now excludes
the characters inside [code] and [codeblock].

Resolves: #15156
(cherry picked from commit 84e8c49f5d)
This commit is contained in:
Anish 2018-02-16 02:24:05 +05:30 committed by Hein-Pieter van Braam
parent 57f707f951
commit 5c2b2ca95b
1 changed files with 26 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
doc/tools/makerst.py
View File

@ -155,8 +155,9 @@ def rstize_text(text, cclass):
# Escape * character to avoid interpreting it as emphasis # Escape * character to avoid interpreting it as emphasis
pos = 0 pos = 0
next_brac_pos = text.find('[');
while True: while True:
pos = text.find('*', pos) pos = text.find('*', pos, next_brac_pos)
if pos == -1: if pos == -1:
break break
text = text[:pos] + "\*" + text[pos + 1:] text = text[:pos] + "\*" + text[pos + 1:]
@ -165,7 +166,7 @@ def rstize_text(text, cclass):
# Escape _ character at the end of a word to avoid interpreting it as an inline hyperlink # Escape _ character at the end of a word to avoid interpreting it as an inline hyperlink
pos = 0 pos = 0
while True: while True:
pos = text.find('_', pos) pos = text.find('_', pos, next_brac_pos)
if pos == -1: if pos == -1:
break break
if not text[pos + 1].isalnum(): # don't escape within a snake_case word if not text[pos + 1].isalnum(): # don't escape within a snake_case word
@ -264,6 +265,27 @@ def rstize_text(text, cclass):
if escape_post and post_text and post_text[0].isalnum(): # not punctuation, escape if escape_post and post_text and post_text[0].isalnum(): # not punctuation, escape
post_text = '\ ' + post_text post_text = '\ ' + post_text
next_brac_pos = post_text.find('[',0)
iter_pos = 0
while not inside_code:
iter_pos = post_text.find('*', iter_pos, next_brac_pos)
if iter_pos == -1:
break
post_text = post_text[:iter_pos] + "\*" + post_text[iter_pos + 1:]
iter_pos += 2
iter_pos = 0
while not inside_code:
iter_pos = post_text.find('_', iter_pos, next_brac_pos)
if iter_pos == -1:
break
if not post_text[iter_pos + 1].isalnum(): # don't escape within a snake_case word
post_text = post_text[:iter_pos] + "\_" + post_text[iter_pos + 1:]
iter_pos += 2
else:
iter_pos += 1
text = pre_text + tag_text + post_text text = pre_text + tag_text + post_text
pos = len(pre_text) + len(tag_text) pos = len(pre_text) + len(tag_text)
@ -500,7 +522,7 @@ def make_rst_class(node):
enums.append(c) enums.append(c)
else: else:
consts.append(c) consts.append(c)
if len(consts) > 0: if len(consts) > 0:
f.write(make_heading('Numeric Constants', '-')) f.write(make_heading('Numeric Constants', '-'))
for c in list(consts): for c in list(consts):
@ -512,7 +534,7 @@ def make_rst_class(node):
s += ' --- ' + rstize_text(c.text.strip(), name) s += ' --- ' + rstize_text(c.text.strip(), name)
f.write(s + '\n') f.write(s + '\n')
f.write('\n') f.write('\n')
if len(enum_names) > 0: if len(enum_names) > 0:
f.write(make_heading('Enums', '-')) f.write(make_heading('Enums', '-'))
for e in enum_names: for e in enum_names: