[ENH] Sphinx extension to plot workflows #1896
Conversation
|
Example: Also links the resource profile documentation (https://551-17021985-gh.circle-artifacts.com/0/home/ubuntu/work/docs/users/resource_sched_profiler.html) in the user documentation index (#1526) . |
nipype/utils/filemanip.py
Outdated
| """ | ||
| Equivalent to bash's mkdir -p | ||
| """ | ||
| if not os.path.exists(folder): |
There was a problem hiding this comment.
You might want to use os.path.isdir, which will throw an EEXIST if a non-directory exists.
Codecov Report
@@ Coverage Diff @@
## master #1896 +/- ##
==========================================
- Coverage 72.92% 70.57% -2.35%
==========================================
Files 1061 1059 -2
Lines 53749 53688 -61
Branches 7728 7791 +63
==========================================
- Hits 39194 37888 -1306
- Misses 13341 14416 +1075
- Partials 1214 1384 +170
Continue to review full report at Codecov.
|
nipype/utils/filemanip.py
Outdated
| Equivalent to bash's mkdir -p | ||
| """ | ||
| try: | ||
| os.makedirs(folder) |
There was a problem hiding this comment.
on py3 we should just use os.makedirs(exist_ok=True), (also see bug that was fixed here: https://bugs.python.org/issue21082)
for py2, i'm still worried about race conditions, given that this is something people can start using. how about, just make this a hidden function for the moment and use it in the extension?
Adds a sphinx extension to the nipype installation. After adding
nipype.sphinxext.plot_workflowto theextensionslist in thedoc/conf.py, sphinx will parse blocks like:The graph is embedded at the point where the block is placed in the docstring.