michaelh/zephyr
1
0
Fork 0
Code Releases Activity
zephyr/doc/templates/board.tmpl

50 lines
872 B
Cheetah
Raw Permalink Normal View History

doc: fix .rst files canonical heading order 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>
2017-01-21 00:58:05 +01:00
.. _boardname_linkname:
boards: prepare for integration of board documentation 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>
2016-12-25 16:58:23 +01:00
[Board Name]
#############
Overview
doc: fix .rst files canonical heading order 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>
2017-01-21 00:58:05 +01:00
********
boards: prepare for integration of board documentation 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>
2016-12-25 16:58:23 +01:00
[A short description about the board, its main features and availability]
docs: add figure to board doc template Add example of how to add an image for the board. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-02-10 23:47:25 +01:00
.. figure:: board_name.png
:width: 800px
:align: center
:alt: Board Name
Board Name (Credit: <owner>)
boards: prepare for integration of board documentation 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>
2016-12-25 16:58:23 +01:00
Hardware
doc: fix .rst files canonical heading order 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>
2017-01-21 00:58:05 +01:00
********
boards: prepare for integration of board documentation 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>
2016-12-25 16:58:23 +01:00
[General Hardware information]
Supported Features
doc: fix .rst files canonical heading order 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>
2017-01-21 00:58:05 +01:00
==================
boards: prepare for integration of board documentation 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>
2016-12-25 16:58:23 +01:00
[List of supported features and level of support in Zephyr]
Connections and IOs
doc: fix .rst files canonical heading order 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>
2017-01-21 00:58:05 +01:00
===================
boards: prepare for integration of board documentation 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>
2016-12-25 16:58:23 +01:00
[Tables describing the board PINs and how they are configured and can be used
to connect external components]
Programming and Debugging
doc: fix .rst files canonical heading order 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>
2017-01-21 00:58:05 +01:00
*************************
boards: prepare for integration of board documentation 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>
2016-12-25 16:58:23 +01:00
Flashing
doc: fix .rst files canonical heading order 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>
2017-01-21 00:58:05 +01:00
========
boards: prepare for integration of board documentation 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>
2016-12-25 16:58:23 +01:00
[How to use this board with Zephyr and how to flash a Zephyr binary on this
device]
Debugging
doc: fix .rst files canonical heading order 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>
2017-01-21 00:58:05 +01:00
=========
boards: prepare for integration of board documentation 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>
2016-12-25 16:58:23 +01:00
[ How to debug this board]
References
doc: fix .rst files canonical heading order 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>
2017-01-21 00:58:05 +01:00
**********
boards: prepare for integration of board documentation 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>
2016-12-25 16:58:23 +01:00
[ Links to external references such as datasheets or additional documentation]
Copy permalink