Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🎨 Use nipype.sphinxext.plot_workflow instead of exec to include workflow diagrams in docstrings #246

Open
shnizzedy opened this issue Nov 25, 2020 · 0 comments

Comments

@shnizzedy
Copy link
Member

Related problem

Not really a problem, but something that could be improved.

Currently we run exec:: directives in docstrings to generate workflow graphs for Nipype workflows. This works fine but displays a blank line of output.

example current exec:: workflow

Nipype has a Sphinx extension to build the graphs with less code in the docstrings and without the blank line of output displaying.

Proposed feature

Include 'nipype.sphinxext.plot_workflow' in https://github.com/FCP-INDI/fcp-indi.github.com/blob/565c9e02850f09a57fb2971fa4ed365819657d32/docs/_sources/conf.py#L118-L128

Replace exec:: workflow directives in docstrings with pithier workflow:: directives.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: No status
Development

No branches or pull requests

1 participant