diff options
author | Florian Dold <florian.dold@gmail.com> | 2019-08-29 17:38:33 +0200 |
---|---|---|
committer | Florian Dold <florian.dold@gmail.com> | 2019-08-29 17:38:33 +0200 |
commit | 26f70933dcc0cfb8b5fc0cdf4f9908a74748f330 (patch) | |
tree | 58939d3594fb8594e72f195fb9d0c2d4cafeda91 | |
parent | ee1786d6a56efc2b59f3b2ae5e5c9d20a11dbcec (diff) | |
download | docs-26f70933dcc0cfb8b5fc0cdf4f9908a74748f330.tar.gz docs-26f70933dcc0cfb8b5fc0cdf4f9908a74748f330.tar.bz2 docs-26f70933dcc0cfb8b5fc0cdf4f9908a74748f330.zip |
add README and allow markdown sources
-rw-r--r-- | README | 6 | ||||
-rw-r--r-- | conf.py | 10 |
2 files changed, 13 insertions, 3 deletions
@@ -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 @@ -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' |