↗️ convert a markdown README to rst, if possible

jhermann · Apr 30, 2015 · b054d5f · b054d5f
1 parent 29a6009
commit b054d5f
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/src/rituals/acts/documentation.py b/src/rituals/acts/documentation.py
@@ -28,6 +28,7 @@
 from invoke import Collection, ctask as task
 
 from .. import config
+from ..util import notify
 from ..util.filesys import pushd
 
 
@@ -39,6 +40,16 @@ def sphinx(ctx, browse=False, opts=''):
     """Build Sphinx docs."""
     cfg = config.load()
 
+    # Convert README, if applicable
+    readme_md = cfg.rootjoin('README.md')
+    if os.path.exists(readme_md):
+        try:
+            import pypandoc
+        except ImportError as exc:
+            notify.warning("Can't import 'pandoc' ({})".format(exc))
+        else:
+            pypandoc.convert(readme_md, 'rst', outputfile=os.path.join(ctx.docs.sources, 'README.rst'))
+
     # Build API docs
     cmd = ['sphinx-apidoc', '-o', 'api', '-f', '-M']
     for package in cfg.project.packages: