millironx/nfdocs-parser
1
0
Fork 0
mirror of https://github.com/MillironX/nfdocs-parser.git synced 2024-11-21 16:46:05 +00:00
Code Issues Releases Packages Activity

Add document tree creation based on docstrings

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-05 16:31:56 -06:00
parent 0256c01c20
commit 01bd885867
Signed by: millironx
GPG key ID: 139C07724802BC5D
1 changed files with 26 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
nfdocs-parser.py
View file

@ -91,5 +91,29 @@ with open(nextflow_path) as nextflow_file:
doc_yaml = doc_yaml + nextflow_lines[i].replace(DOC_STARTER, "")
docstrings[proc_type][proc_name] = yaml.safe_load(doc_yaml)
# Display the results so far
print(docstrings)
# Create any array to return from the plugin
return_nodes = []
# Try to convert each definition to a node
for block_type, block_docs in docstrings.items():
block_section = nodes.section()
block_section += nodes.title(text=block_type)
for proc_name, proc_docs in block_docs.items():
proc_section = nodes.section()
proc_section += nodes.title(text=proc_name)
proc_section += nodes.paragraph(text=proc_docs["summary"])
io_methods = ["input", "output"]
for met in io_methods:
if met in proc_docs.keys():
io_section = nodes.section()
io_section += nodes.title(text=met)
io_list = nodes.bullet_list()
for io in proc_docs[met]:
io_list += params_to_list(io)
io_section += io_list
proc_section += io_section
block_section += proc_section
return_nodes.append(block_section)
print(return_nodes)