From 66a042735c6fb8dd895fd503c07a161bfa00119e Mon Sep 17 00:00:00 2001
From: Jutta Schnabel <jutta.schnabel@fau.de>
Date: Tue, 20 Aug 2024 11:35:30 +0200
Subject: [PATCH] adding json schema reading
---
.gitlab-ci.yml | 1 +
docs/source/conf.py | 2 +-
docs/source/index.rst | 6 +-----
docs/source/testdomain.rst | 3 +++
requirements.txt | 1 +
.../{dataformat_standard.js => dataformat_standard.json} | 0
6 files changed, 7 insertions(+), 6 deletions(-)
create mode 100644 docs/source/testdomain.rst
rename specs/templates/{dataformat_standard.js => dataformat_standard.json} (100%)
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index b787b45..c6d2148 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -15,6 +15,7 @@ before_script:
build_docs:
stage: build
script:
+ - cp specs docs/source/specs
- sphinx-build -b html $DOCS_DIR/source $BUILD_DIR
artifacts:
paths:
diff --git a/docs/source/conf.py b/docs/source/conf.py
index a1d7e8c..2696bc7 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -49,7 +49,7 @@ exclude_patterns = []
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
-html_theme = 'alabaster'
+html_theme = 'sphinx-rtd-theme'
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
diff --git a/docs/source/index.rst b/docs/source/index.rst
index c81337d..3ee04ac 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -1,8 +1,3 @@
-.. KM3NeT Dataformat Specifications documentation master file, created by
- sphinx-quickstart on Tue Aug 20 09:58:21 2024.
- You can adapt this file completely to your liking, but it should at least
- contain the root `toctree` directive.
-
Welcome to KM3NeT Dataformat Specifications's documentation!
============================================================
@@ -10,6 +5,7 @@ Welcome to KM3NeT Dataformat Specifications's documentation!
:maxdepth: 2
:caption: Contents:
+ testdomain
Indices and tables
diff --git a/docs/source/testdomain.rst b/docs/source/testdomain.rst
new file mode 100644
index 0000000..34e4379
--- /dev/null
+++ b/docs/source/testdomain.rst
@@ -0,0 +1,3 @@
+
+
+.. jsonschema:: specs/templates/dataformat_standard.json
diff --git a/requirements.txt b/requirements.txt
index c6b464c..305a62a 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -1,2 +1,3 @@
sphinx
+sphinx-rtd-theme
sphinx-jsonschema
diff --git a/specs/templates/dataformat_standard.js b/specs/templates/dataformat_standard.json
similarity index 100%
rename from specs/templates/dataformat_standard.js
rename to specs/templates/dataformat_standard.json
--
GitLab