Merge branch 'f-json-specification-doc' into 'dev'

F json specification doc

See merge request !74

src/doc/cfood-schema.yml

+../caoscrawler/cfood-schema.yml
\ No newline at end of file

src/doc/cfood-specification.rst

+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

src/doc/conf.py

@@ -56,6 +56,8 @@ extensions = [
     "sphinx.ext.todo",
     "recommonmark",            # For markdown files.
     "sphinx_rtd_theme",
+    'sphinx.ext.autodoc',
+    'sphinx-jsonschema',
 ]
 
 # Add any paths that contain templates here, relative to this directory.

src/doc/index.rst

@@ -12,6 +12,7 @@ CaosDB-Crawler Documentation
    Concepts<concepts>
    Converters<converters/index>
    CFoods (Crawler Definitions)<cfood>
+   CFood-Specification<cfood-specification>
    Macros<macros>
    How to upgrade<how-to-upgrade>
    API documentation<_apidoc/modules>