taler-docs

commit 26f70933dcc0cfb8b5fc0cdf4f9908a74748f330
parent ee1786d6a56efc2b59f3b2ae5e5c9d20a11dbcec
Author: Florian Dold <florian.dold@gmail.com>
Date:   Thu, 29 Aug 2019 17:38:33 +0200

add README and allow markdown sources

Diffstat:
A
README
 | 
6
++++++
M
conf.py
 | 
10
+++++++---

2 files changed, 13 insertions(+), 3 deletions(-)
diff --git a/README b/README
@@ -0,0 +1,6 @@
+This repository contains the documentation for all main GNU Taler components.
+
+Before building the documentation, make sure that you have the required
+dependencies installed using pip3:
+
+$ pip3 install --user --upgrade recommonmark sphinx
diff --git a/conf.py b/conf.py
@@ -51,14 +51,18 @@ extensions = [
     'tsref',
     'sphinx.ext.todo',
     'sphinx.ext.imgmath',
-    'httpdomain.httpdomain'
+    'httpdomain.httpdomain',
+    'recommonmark',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
-# The suffix of source filenames.
-source_suffix = '.rst'
+source_suffix = {
+    '.rst': 'restructuredtext',
+    '.txt': 'markdown',
+    '.md': 'markdown',
+}
 
 # The encoding of source files.
 #source_encoding = 'utf-8-sig'