From 7f57b18f93f94d5faa67870a6a6a9ea5c7543384 Mon Sep 17 00:00:00 2001 From: Henry Schreiner Date: Tue, 17 Oct 2023 12:37:06 -0400 Subject: [PATCH] docs: clarify draft status Signed-off-by: Henry Schreiner --- docs/conf.py | 4 ++++ docs/serialization.md | 6 ++++++ src/uhi/resources/{histogram.json => histogram.schema.json} | 2 +- 3 files changed, 11 insertions(+), 1 deletion(-) rename src/uhi/resources/{histogram.json => histogram.schema.json} (98%) diff --git a/docs/conf.py b/docs/conf.py index 6fd87d6..9b99e87 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,6 +48,10 @@ # This pattern also affects html_static_path and html_extra_path. exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] +myst_enable_extensions = [ + "colon_fence", +] + # -- Options for HTML output ------------------------------------------------- diff --git a/docs/serialization.md b/docs/serialization.md index cd2bddf..7390a78 100644 --- a/docs/serialization.md +++ b/docs/serialization.md @@ -1,5 +1,11 @@ # Serialization +:::{warning} + +Serialization is in draft currently. Once at least one implementation is ready, +we will remove this warning and release UHI 0.5. + +::: ## Introduction diff --git a/src/uhi/resources/histogram.json b/src/uhi/resources/histogram.schema.json similarity index 98% rename from src/uhi/resources/histogram.json rename to src/uhi/resources/histogram.schema.json index e62ecbb..93343f5 100644 --- a/src/uhi/resources/histogram.json +++ b/src/uhi/resources/histogram.schema.json @@ -1,6 +1,6 @@ { "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "https://raw.githubusercontent.com/scikit-hep/uhi/henryiii/feat/schema/src/uhi/resources/histogram.json", + "$id": "https://raw.githubusercontent.com/scikit-hep/uhi/main/src/uhi/resources/histogram.schema.json", "title": "Histogram", "type": "object", "additionalProperties": false,