Merge 69e54fc into 3a87e26

sphinx_nbexamples/__init__.py

@@ -838,8 +838,14 @@ def recursive_processing(self, base_dir, target_dir, it):
             if label:
                 labels[label] = nbps
         s = ".. _%s:\n\n" % this_label
-        with open(os.path.join(file_dir, readme_file)) as f:
-            s += f.read().rstrip() + '\n\n'
+
+        if readme_file.endswith('.md'):
+            s += spr.check_output(
+                ['pandoc', os.path.join(file_dir, readme_file),
+                 '-t', 'rst']).decode('utf-8').rstrip() + '\n\n'
+        else:
+            with open(os.path.join(file_dir, readme_file)) as f:
+                s += f.read().rstrip() + '\n\n'
 
         s += "\n\n.. toctree::\n\n"
         s += ''.join('    %s\n' % os.path.splitext(os.path.basename(

tests/sphinx_supp_py2/raw_examples/sub/README.rst → tests/sphinx_supp_py2/raw_examples/sub/README.md

@@ -1,2 +1,4 @@
 Some additional examples in a subfolder
 =======================================
+
+This is [a markdown link](https://www.google.de/).

tests/sphinx_supp_py3/raw_examples/sub/README.rst → tests/sphinx_supp_py3/raw_examples/sub/README.md

@@ -1,2 +1,4 @@
 Some additional examples in a subfolder
 =======================================
+
+This is [a markdown link](https://www.google.de/).

tests/test_sphinx_nbexamples.py

@@ -191,6 +191,15 @@ def test_given_thumb(self):
                       msg=('The wrong picture has been chosen for '
                            'example_mpl_test_figure_chosen.ipynb'))
 
+    def test_md_readme(self):
+        """Test the conversion of README.md"""
+        html_path = osp.join(self.out_dir, 'examples', 'sub', 'index.html')
+        self.assertTrue(osp.exists(html_path),
+                        msg=html_path + ' is missing!')
+        with open(html_path) as f:
+            html = f.read()
+        self.assertIn('a markdown link</a>', html)
+
 
 @unittest.skipIf(pathlib is None, 'The pathlib package is required!')
 class TestLinkGalleries(BaseTest):