ignore schema doc from spelling check

canonical · Dec 6, 2023 · 58565ba · 58565ba
1 parent d6df36d
commit 58565ba
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 7 deletions.
diff --git 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
@@ -3,15 +3,17 @@
 Submission Schema
 ==================
 
-Checkbox :ref:`Submission files <submission-files>` provide a summary of the test results and in-depth information that help analyzing the tests. 
+Checkbox :ref:`submissions <submission-files>` 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 <https://certification.canonical.com>`_ as part of the submission. To get the latest schema definition file in Json, go to the Checkbox `GitHub repository <https://github.com/canonical/checkbox/blob/main/submission-schema/schema.json>`_.
+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 <https://github.com/canonical/checkbox/blob/main/submission-schema/schema.json>`_.
 
 .. 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:
-
+
+.. container:: spellignore
+    .. class used to ignore spelling check
+        
+    .. jsonschema:: ../../submission-schema/schema.json
+        :lift_definitions:
+        :auto_reference: