michaelh/zephyr
1
0
Fork 0
Code Releases Activity

boards: prepare for integration of board documentation

Browse source 
Re-add board documentation and integrate into the project online
documentation.

Setup sphinx to pick any new board documentation added to boards/*.

Change-Id: Id208d5ef923f8806135879dd33a55ed527dc5f27
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
This commit is contained in:
Anas Nashif 2016-12-25 10:58:23 -05:00 • committed by Anas Nashif
commit 983d3f2387
7 changed files with 56 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

39
doc/templates/board.tmpl vendored Normal file
View file

@ -0,0 +1,39 @@
[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]