From 26f70933dcc0cfb8b5fc0cdf4f9908a74748f330 Mon Sep 17 00:00:00 2001 From: Florian Dold Date: Thu, 29 Aug 2019 17:38:33 +0200 Subject: add README and allow markdown sources --- README | 6 ++++++ conf.py | 10 +++++++--- 2 files changed, 13 insertions(+), 3 deletions(-) create mode 100644 README diff --git a/README b/README new file mode 100644 index 00000000..55a9c430 --- /dev/null +++ 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 index 47f494ff..2558c784 100644 --- 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' -- cgit v1.2.3