diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index b787b4584f27c0d4a06ba41f62984d5ca1d6a27f..c6d2148a7f4451c76a0124c6a2798385a3575518 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 a1d7e8cc6d4c42556a2ba23c41d1e63c2a2fd760..2696bc79b6806051f0435350f4c4cb4c31f023ce 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 c81337d1afe90669c532e01d3a780b6f6a676f07..3ee04acd2f05f6941fb9164f44c9ab8d6e81448c 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 0000000000000000000000000000000000000000..34e4379e460d033090db651011db67d5e29c56ab --- /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 c6b464c3f749e95239ab44e8b892d76b8aae5fd4..305a62a2dc76081357228d200b754f89abc40564 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