michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: fix .rst files canonical heading order

Browse source 
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>
This commit is contained in:
David B. Kinder 2017-01-20 15:58:05 -08:00
commit 2cb045420c
37 changed files with 248 additions and 244 deletions
Download patch file Download diff file Expand all files Collapse all files

18
doc/templates/board.tmpl vendored
View file

@ -1,39 +1,41 @@
.. _boardname_linkname:
[Board Name]
#############
Overview
========
********
[A short description about the board, its main features and availability]
Hardware
=========
********
[General Hardware information]
Supported Features
------------------
==================
[List of supported features and level of support in Zephyr]
Connections and IOs
--------------------
===================
[Tables describing the board PINs and how they are configured and can be used
to connect external components]
Programming and Debugging
=========================
*************************
Flashing
--------
========
[How to use this board with Zephyr and how to flash a Zephyr binary on this
device]
Debugging
---------
=========
[ How to debug this board]
References
==========
**********
[ Links to external references such as datasheets or additional documentation]

12
doc/templates/sample.tmpl vendored
View file

@ -1,29 +1,31 @@
.. _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]