From 6d304174dafa90c6b5bbb818a192ecada0bdca61 Mon Sep 17 00:00:00 2001 From: nuest Date: Tue, 30 Oct 2018 11:34:27 +0100 Subject: [PATCH] add Stencila config files to docs --- docs/source/config_files.rst | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/source/config_files.rst b/docs/source/config_files.rst index fe3fb02e..3834c3fe 100644 --- a/docs/source/config_files.rst +++ b/docs/source/config_files.rst @@ -107,6 +107,22 @@ You also need to have a ``runtime.txt`` file that is formatted as ``r---
``, where YYYY-MM-DD is a snapshot of MRAN that will be used for your R installation. +``manifest.xml`` - Install Stencila +=================================== + +`Stencila `_ is an open source office suite for reproducible research. +It is powered by the open file format `Dar `_. + +If your repository contains a Stencila document, repo2docker detects it based on the file ``manifest.xml``. +The required `execution contexts ` are extracted from a Dar article (i.e. +files named ``*.jats.xml``). + +You may also have a ``runtime.txt`` and/or an ``install.R`` to manually configure the your R installation. + +To see example repositories, visit our +`Stencila with R `_ and +`Stencila with Python `_ examples. + .. _postBuild: ``postBuild`` - Run code after installing the environment