mirror of
https://github.com/zephyrproject-rtos/zephyr
synced 2025-08-19 19:08:56 +00:00
2cb045420c
The headings on some .rst files were not following the expected heading order of using # for h1, * for h2, = for h3, and - for h4 This patch fixes that, and the doc/templates/*.tmpl files created for folks to use as templates for creating board and sample docs. Change-Id: I0263b005648558d5ea41a681ceaa4798c9594dd9 Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
32 lines
826 B
Cheetah
32 lines
826 B
Cheetah
.. _descriptive_title_link_name:
|
|
|
|
[A Descriptive Title]
|
|
#####################
|
|
|
|
Overview
|
|
********
|
|
[A short description about the sample and what it does]
|
|
|
|
Requirements
|
|
************
|
|
[List of required software and hardware components. Provide pointers to
|
|
hardware components such as sensors and shields]
|
|
|
|
Wiring
|
|
******
|
|
[For simple projects, a description of how to wire the board for the demo. For
|
|
complex projects, provide a graphic with more details, preferably using
|
|
Fritzing or some other visualisation tools]
|
|
|
|
Building and Running
|
|
********************
|
|
[ How to build the sample and how to run it. Pointers to where to find the
|
|
sample in the source tree and how to configure it and run it for a specific
|
|
target platform]
|
|
|
|
References
|
|
**********
|
|
[ Links to external references such as datasheets or additional documentation]
|
|
|
|
|