millironx/nfdocs-parser
1
0
Fork 0
mirror of https://github.com/MillironX/nfdocs-parser.git synced 2024-11-24 09:49:56 +00:00
Code Issues Releases Packages Activity

Remove function params_to_list from NFDocs class

Browse source 
Signed-off-by: Thomas A. Christensen II <25492070+MillironX@users.noreply.github.com>
This commit is contained in:
Thomas A. Christensen II 2022-01-10 16:15:51 -06:00
parent f555cd9c20
commit f1b695baf9
Signed by: millironx
GPG key ID: 139C07724802BC5D
1 changed files with 20 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

40
nfdocs-parser.py
View file

@ -25,6 +25,25 @@ def definition_type(signature):
# Return the results # Return the results
return def_name, def_type return def_name, def_type
def params_to_list(params):
if "tuple" in params.keys():
tuple_item = nodes.list_item()
if "name" in params.keys():
tuple_item += nodes.paragraph(text=params["name"])
tuple_item += nodes.paragraph(text="Tuple:")
tuple_list = nodes.bullet_list()
for io in params["tuple"]:
tuple_list += params_to_list(io)
tuple_item += tuple_list
return tuple_item
else:
io_item = nodes.list_item()
if "name" in params.keys():
io_item += nodes.paragraph(text=params["name"])
io_item += nodes.paragraph(text=f"Type: {params['type']}")
io_item += nodes.paragraph(text=params["description"])
return io_item
class NFDocs(Directive): class NFDocs(Directive):
# Class default overrides # Class default overrides
required_arguments = 1 required_arguments = 1
@ -32,25 +51,6 @@ class NFDocs(Directive):
# Declare the docstring starting characters # Declare the docstring starting characters
DOC_STARTER = "/// " DOC_STARTER = "/// "
def params_to_list(self, params):
if "tuple" in params.keys():
tuple_item = nodes.list_item()
if "name" in params.keys():
tuple_item += nodes.paragraph(text=params["name"])
tuple_item += nodes.paragraph(text="Tuple:")
tuple_list = nodes.bullet_list()
for io in params["tuple"]:
tuple_list += self.params_to_list(io)
tuple_item += tuple_list
return tuple_item
else:
io_item = nodes.list_item()
if "name" in params.keys():
io_item += nodes.paragraph(text=params["name"])
io_item += nodes.paragraph(text=f"Type: {params['type']}")
io_item += nodes.paragraph(text=params["description"])
return io_item
def run(self): def run(self):
# Take path as single argument for now # Take path as single argument for now
nextflow_path = self.arguments[0] nextflow_path = self.arguments[0]
@ -121,7 +121,7 @@ class NFDocs(Directive):
io_section += nodes.title(text=met) io_section += nodes.title(text=met)
io_list = nodes.bullet_list() io_list = nodes.bullet_list()
for io in proc_docs[met]: for io in proc_docs[met]:
io_list += self.params_to_list(io) io_list += params_to_list(io)
io_section += io_list io_section += io_list
proc_section += io_section proc_section += io_section
self.state_machine.document.note_implicit_target(io_section) self.state_machine.document.note_implicit_target(io_section)