OrgZephyr/zephyr
OrgZephyr
/
zephyr
mirror of https://github.com/zephyrproject-rtos/zephyr.git
1
0
Fork 0
Code Issues Releases Wiki Activity
zephyr/boards/index.rst

26 lines
487 B
ReStructuredText
Raw Normal View History

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 23:58:23 +08:00
.. _boards:
Supported Boards
################
eoc: move non-board docs from boards TOC list A couple of docs were created in previous PRs with board support information common to a few boards. Move these to a new section for "Board Support Tools". (I debated about hiding them completely but decided it would still be useful to have these tool docs appear in the table of contents, just not embedded with the supported boards docs.) Moved these board tools docs over to the doc/ folder and out of boards/ and removed these pages from the navigation index. JIRA: ZEP-2285 Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2017-06-16 06:44:04 +08:00
Zephyr project developers are continually adding board-specific support as
documented below.
doc: remove links to wiki Wiki is being obsoleted, so remove any links that might become dead really soon. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2017-05-21 21:27:51 +08:00
To add support documentation for a new board, please use the template available
doc: use :zephyr_file: where appropriate A new role :zephyr_file: is available that renders to a link to the file or folder in GitHub. Find appropriate references using :file: and convert to :zephyr_file: to take advantage of its linking capability. Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-03-09 06:21:37 +08:00
under :zephyr_file:`doc/templates/board.tmpl`
boards: add quark_d2000_crb documentation Change-Id: Idb4ed43c8639cee2673dff24b18ff2ccd76a1396 Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2017-01-07 01:55:21 +08:00
boards: categorize boards by architecture Change-Id: I6bf5dc9d3aed2ffea23aa680188c18f4af601fec Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2017-01-15 09:10:34 +08:00
.. toctree::
doc: fix sidebar nav issues with board docs Sidebar navigation for supported boards is wonky: opens to show all boards (making for lots of scrolling to see the sidebar) and sidebar items aren't always clickable (as explained in the JIRA issue). Fix is to not use multiple toctree directives in boards.rst and create intermediate architecture-specific supported board docs. JIRA: INF-132 Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2017-06-24 02:40:11 +08:00
:maxdepth: 2
boards: categorize boards by architecture Change-Id: I6bf5dc9d3aed2ffea23aa680188c18f4af601fec Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2017-01-15 09:10:34 +08:00
doc: fix sidebar nav issues with board docs Sidebar navigation for supported boards is wonky: opens to show all boards (making for lots of scrolling to see the sidebar) and sidebar items aren't always clickable (as explained in the JIRA issue). Fix is to not use multiple toctree directives in boards.rst and create intermediate architecture-specific supported board docs. JIRA: INF-132 Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2017-06-24 02:40:11 +08:00
x86/index.rst
arm/index.rst
arm/arm64: Fix misc and trivials for ARM/ARM64 split Fix the header guards, comments, github labeler, CODEOWNERS and MAINTAINERS files. Signed-off-by: Carlo Caione <ccaione@baylibre.com>
2021-03-26 22:22:59 +08:00
arm64/index.rst
doc: fix sidebar nav issues with board docs Sidebar navigation for supported boards is wonky: opens to show all boards (making for lots of scrolling to see the sidebar) and sidebar items aren't always clickable (as explained in the JIRA issue). Fix is to not use multiple toctree directives in boards.rst and create intermediate architecture-specific supported board docs. JIRA: INF-132 Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2017-06-24 02:40:11 +08:00
arc/index.rst
nios2/index.rst
xtensa/index.rst
board: posix: add native_posix board definition Signed-off-by: Alberto Escolar Piedras <alpi@oticon.com> Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2017-12-21 21:14:19 +08:00
posix/index.rst
riscv32: rename to riscv With the upcoming riscv64 support, it is best to use "riscv" as the subdirectory name and common symbols as riscv32 and riscv64 support code is almost identical. Then later decide whether 32-bit or 64-bit compilation is wanted. Redirects for the web documentation are also included. Then zephyrbot complained about this: " New files added that are not covered in CODEOWNERS: dts/riscv/microsemi-miv.dtsi dts/riscv/riscv32-fe310.dtsi Please add one or more entries in the CODEOWNERS file to cover those files " So I assigned them to those who created them. Feel free to readjust as necessary. Signed-off-by: Nicolas Pitre <npitre@baylibre.com>
2019-07-18 01:17:05 +08:00
riscv/index.rst
boards: Add qemu_leon3 This board configuration can be used out-of-the-box with SPARC QEMU distributed with Zephyr SDK v0.11.2. Signed-off-by: Martin Åberg <martin.aberg@gaisler.com>
2020-10-17 03:04:25 +08:00
sparc/index.rst
doc: provide shield usage documentation Following introduction of shield feature, provide requested documentation. Signed-off-by: Erwan Gouriou <erwan.gouriou@linaro.org>
2018-04-09 23:27:57 +08:00
shields/index.rst