From f052f6055b29df60af6e0e77c198e5c99aaea68d Mon Sep 17 00:00:00 2001 From: Michal Stolarczyk Date: Fri, 16 Jul 2021 09:58:54 -0400 Subject: [PATCH] Add `pepschema` directive in the documentation (#1092) * Add `pepschema` directive docs add links to eido and how to write a PEP schema guide * add pep validation note --- docs/snakefiles/configuration.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/snakefiles/configuration.rst b/docs/snakefiles/configuration.rst index 1beda01a0..f609feed2 100644 --- a/docs/snakefiles/configuration.rst +++ b/docs/snakefiles/configuration.rst @@ -197,6 +197,12 @@ For those, one should always complement the pepfile with an ordinary :ref:`confi The rationale is that PEPs should be portable between different data analysis workflows (that could be applied to the same data) and even between workflow management systems. In other words, a PEP should describe everything needed about the data, while a workflow and its configuration should describe everything needed about the analysis that is applied to it. +^^^^^^^^^^^^^^^ +Validating PEPs +^^^^^^^^^^^^^^^ + +Using the ``pepschema`` directive leads to an automatic parsing of the provided schema *and* PEP validation with the PEP validation tool -- `eido `_. Eido schemas extend `JSON Schema `_ vocabulary to accommodate the powerful PEP features. Follow the `How to write a PEP schema `_ guide to learn more. + .. _snakefiles-cluster_configuration: ----------------------------------