maxmustermann/godot
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

makerst: Add descriptions to method qualifiers

Browse source 
This closes https://github.com/godotengine/godot-docs/issues/1753.
This commit is contained in:
Hugo Locurcio 2020-07-30 11:41:12 +02:00
parent 35ff38b3d4
commit c162a39c7b
No known key found for this signature in database
GPG key ID: 39E8F8BE30B0A49C
1 changed files with 18 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
doc/tools/makerst.py
View file

@ -565,6 +565,8 @@ def make_rst_class(class_def, state, dry_run, output_dir): # type: (ClassDef, S
index += 1
f.write(make_footer())
def escape_rst(text, until_pos=-1): # type: (str) -> str
# Escape \ character, otherwise it ends up as an escape character in rst
@ -995,7 +997,10 @@ def make_method_signature(
out += " **)**"
if isinstance(method_def, MethodDef) and method_def.qualifiers is not None:
out += " " + method_def.qualifiers
# Use substitutions for abbreviations. This is used to display tooltips on hover.
# See `make_footer()` for descriptions.
for qualifier in method_def.qualifiers.split():
out += " |" + qualifier + "|"
return ret_type, out
@ -1004,6 +1009,18 @@ def make_heading(title, underline): # type: (str, str) -> str
return title + "\n" + (underline * len(title)) + "\n\n"
def make_footer(): # type: () -> str
# Generate reusable abbreviation substitutions.
# This way, we avoid bloating the generated rST with duplicate abbreviations.
# fmt: off
return (
".. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`\n"
".. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`\n"
".. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`"
)
# fmt: on
def make_url(link): # type: (str) -> str
match = GODOT_DOCS_PATTERN.search(link)
if match: