docs: dt: writing-schema: Include the example schema in the doc build
authorRob Herring <robh@kernel.org>
Thu, 25 Mar 2021 16:47:08 +0000 (10:47 -0600)
committerRob Herring <robh@kernel.org>
Sat, 27 Mar 2021 18:58:04 +0000 (12:58 -0600)
The example-schema.yaml file serves as documentation, so let's include it
from writing-schema.rst.

Cc: Frank Rowand <frowand.list@gmail.com>
Cc: Mauro Carvalho Chehab <mchehab@kernel.org>
Signed-off-by: Rob Herring <robh@kernel.org>
Reviewed-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/20210325164713.1296407-4-robh@kernel.org
Documentation/devicetree/writing-schema.rst

index 03e279d8fd6aa084c98a02f4733fd4dca4561aaf..be14dbed60819d8bde6897a5db4bdade0a7f8160 100644 (file)
@@ -8,6 +8,8 @@ written in a JSON compatible subset of YAML. YAML is used instead of JSON as it
 is considered more human readable and has some advantages such as allowing
 comments (Prefixed with '#').
 
+Also see :ref:`example-schema`.
+
 Schema Contents
 ---------------
 
@@ -170,3 +172,12 @@ json-schema Resources
 `JSON-Schema Specifications <http://json-schema.org/>`_
 
 `Using JSON Schema Book <http://usingjsonschema.com/>`_
+
+.. _example-schema:
+
+Annotated Example Schema
+------------------------
+
+Also available as a separate file: :download:`example-schema.yaml`
+
+.. literalinclude:: example-schema.yaml