LonamiWebs/Telethon
1
1
Fork 0
mirror of https://github.com/LonamiWebs/Telethon.git synced 2024-11-22 17:36:34 +03:00
Code Issues Packages Projects Releases Wiki Activity

Show types containing the current type as a member on docs

Browse Source
This commit is contained in:
Lonami Exo 2017-05-22 17:28:06 +02:00
parent b477895830
commit 7eaa393271
1 changed files with 26 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
docs/generate.py
View File

@ -294,6 +294,7 @@ def generate_documentation(scheme_file):
# Main file title # Main file title
docs.write_title(get_class_name(name)) docs.write_title(get_class_name(name))
# List available constructors for this type
docs.write_title('Available constructors', level=3) docs.write_title('Available constructors', level=3)
if not constructors: if not constructors:
docs.write_text('This type has no constructors available.') docs.write_text('This type has no constructors available.')
@ -310,6 +311,7 @@ def generate_documentation(scheme_file):
docs.add_row(get_class_name(constructor), link=link) docs.add_row(get_class_name(constructor), link=link)
docs.end_table() docs.end_table()
# List all the methods which return this type
docs.write_title('Methods returning this type', level=3) docs.write_title('Methods returning this type', level=3)
functions = tlfunctions.get(tltype, []) functions = tlfunctions.get(tltype, [])
if not functions: if not functions:
@ -325,6 +327,30 @@ def generate_documentation(scheme_file):
link = get_relative_path(link, relative_to=filename) link = get_relative_path(link, relative_to=filename)
docs.add_row(get_class_name(func), link=link) docs.add_row(get_class_name(func), link=link)
docs.end_table() docs.end_table()
# List every other type which has this type as a member
docs.write_title('Other types containing this type', level=3)
other_types = sorted((t for t in tlobjects
if any(tltype == a.type for a in t.args)),
key=lambda t: t.name)
if not other_types:
docs.write_text(
'No other types have a member of this type.')
elif len(other_types) == 1:
docs.write_text(
'You can find this type as a member of this other type.')
else:
docs.write_text(
'You can find this type as a member of any of '
'the following %d types.' % len(other_types))
docs.begin_table(2)
for ot in other_types:
link = get_create_path_for(ot)
link = get_relative_path(link, relative_to=filename)
docs.add_row(get_class_name(ot), link=link)
docs.end_table()
docs.end_body() docs.end_body()
# After everything's been written, generate an index.html file for every folder. # After everything's been written, generate an index.html file for every folder.