ENH: Import examples from niflow

Author: effigies

doc/.gitignore

@@ -1 +1,2 @@
 /documentation.zip
+_static/python

doc/Makefile

@@ -24,7 +24,7 @@ help:
 	@echo "  doctest   run all doctests embedded in the documentation"
 
 clean:
-	-rm -rf _build/* *~ api/generated interfaces/generated users/examples documentation.zip
+	-rm -rf _build/* *~ api/generated interfaces/generated users/examples documentation.zip _static/python
 
 htmlonly:
 	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) _build/html

doc/conf.py

@@ -13,18 +13,37 @@
 # serve to show the default.
 
 import os
+from pathlib import Path
+from tempfile import TemporaryDirectory
+import shutil
 from packaging.version import Version
 import nipype
+import subprocess as sp
 
-doc_path = os.path.abspath(os.path.dirname(__file__))
-os.makedirs('users/examples', exist_ok=True)
 
-os.chdir(os.path.join(doc_path, 'users', 'examples'))
-os.system("""python ../../../tools/ex2rst -x ../../../examples/test_spm.py \
---project Nipype --outdir . ../../../examples""")
-os.system("""python ../../../tools/ex2rst --project Nipype --outdir . \
-../../../examples/frontiers_paper""")
-os.chdir(doc_path)
+conf_py = Path(__file__)
+
+example_dir = conf_py.parent / 'users' / 'examples'
+shutil.rmtree(example_dir, ignore_errors=True)
+example_dir.mkdir(parents=True)
+python_dir = conf_py.parent / "_static" / "python"
+shutil.rmtree(python_dir, ignore_errors=True)
+
+ex2rst = str(conf_py.parent.parent / "tools" / "ex2rst")
+
+with TemporaryDirectory() as tmpdir:
+    sp.run(["git", "clone", "--depth", "1", "https://github.com/niflows/nipype1-examples.git",
+            tmpdir], check=True)
+    source_dir = Path(tmpdir) / "package" / "niflow" / "nipype1" / "examples"
+    shutil.copytree(source_dir, python_dir)
+
+sp.run(["python", ex2rst, "--project", "Nipype", "--outdir", str(example_dir),
+        "-x", str(python_dir / "test_spm.py"),
+        "-x", str(python_dir / "__init__.py"),
+        "-x", str(python_dir / "cli.py"),
+        str(python_dir)], check=True)
+sp.run(["python", ex2rst, "--project", "Nipype", "--outdir", str(example_dir),
+        str(python_dir / "frontiers_paper")], check=True)
 
 
 # If extensions (or modules to document with autodoc) are in another directory,
@@ -98,7 +117,7 @@
 
 # General information about the project.
 project = u'nipype'
-copyright = u'2009-19, Neuroimaging in Python team'
+copyright = u'2009-20, Neuroimaging in Python team'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the

tools/ex2rst

@@ -190,7 +190,7 @@ def exfile2rstfile(filename, opts):
    This same script is also included in the %s source distribution under the
    :file:`examples` directory.
 
-""" % (filename, opts.project)
+""" % (os.path.relpath(filename, opts.outdir), opts.project)
 
         dfile.write(msg)