From 3e0e3e82bcca0cd9c03d288e97a8247103e21864 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Henrik=20tom=20W=C3=B6rden?= <h.tomwoerden@indiscale.com> Date: Sat, 4 Feb 2023 19:44:47 +0100 Subject: [PATCH] WIP: add explanation --- src/doc/cfood-schema.yml | 1 + src/doc/cfood-specification.rst | 4 ++++ 2 files changed, 5 insertions(+) create mode 120000 src/doc/cfood-schema.yml diff --git a/src/doc/cfood-schema.yml b/src/doc/cfood-schema.yml new file mode 120000 index 00000000..c34280ed --- /dev/null +++ b/src/doc/cfood-schema.yml @@ -0,0 +1 @@ +../caoscrawler/cfood-schema.yml \ No newline at end of file diff --git a/src/doc/cfood-specification.rst b/src/doc/cfood-specification.rst index 453921f9..89588b2d 100644 --- a/src/doc/cfood-specification.rst +++ b/src/doc/cfood-specification.rst @@ -2,5 +2,9 @@ CFood-Specification ((((((((((((((((((( +CFoods are defined using a YAML find that has to abide by the following +specification. The specifiacition is defined using a JSON schema (see +`src/caoscrawler/cfood-schema.yml`). A CFood is basically composed of converter +definitions. A converter definition must have the following structure: .. jsonschema:: cfood-schema.yml#/cfood/$defs/converter -- GitLab