From 58565ba6672534d982b54e02d91a13d147d2e9e1 Mon Sep 17 00:00:00 2001 From: MengT Date: Wed, 6 Dec 2023 11:36:25 +0800 Subject: [PATCH] ignore schema doc from spelling check --- docs/.sphinx/spellingcheck.yaml | 1 + docs/reference/submission-schema.rst | 16 +++++++++------- 2 files changed, 10 insertions(+), 7 deletions(-) diff --git a/docs/.sphinx/spellingcheck.yaml b/docs/.sphinx/spellingcheck.yaml index 6650fd265..254366d23 100644 --- a/docs/.sphinx/spellingcheck.yaml +++ b/docs/.sphinx/spellingcheck.yaml @@ -24,3 +24,4 @@ matrix: - div.relatedlinks - div.visually-hidden - img + - div.spellignore diff --git a/docs/reference/submission-schema.rst b/docs/reference/submission-schema.rst index 742d2eeeb..eb6a9fa2e 100644 --- a/docs/reference/submission-schema.rst +++ b/docs/reference/submission-schema.rst @@ -3,15 +3,17 @@ Submission Schema ================== -Checkbox :ref:`Submission files ` provide a summary of the test results and in-depth information that help analyzing the tests. +Checkbox :ref:`submissions ` contain reports of the tests and in-depth information that helps analyzing the test results. These files are sent to the :term:`Certification Website` for sharing test results. -This document describes the schema the ``submission.json`` files that's sent to the `Certification website `_ as part of the submission. To get the latest schema definition file in Json, go to the Checkbox `GitHub repository `_. +This document describes the schema of the ``submission.json`` files as part of the submission. To get the latest JSON schema file, go to the Checkbox `GitHub repository `_. .. important:: The schema described in this document is work-in-progress and being reviewed. If you need assistance in validating the schema, please contact the Checkbox team. - -.. jsonschema:: ../../submission-schema/schema.json - :lift_definitions: - :auto_reference: - \ No newline at end of file + +.. container:: spellignore + .. class used to ignore spelling check + + .. jsonschema:: ../../submission-schema/schema.json + :lift_definitions: + :auto_reference: