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>
This commit is contained in:
David B. Kinder 2017-06-23 11:40:11 -07:00 committed by Anas Nashif
parent cd19a57811
commit abcb8d446e
6 changed files with 56 additions and 41 deletions

10
boards/arc/index.rst Normal file
View File

@ -0,0 +1,10 @@
.. _boards-arc:
ARC Boards
##########
.. toctree::
:maxdepth: 1
:glob:
**/*

10
boards/arm/index.rst Normal file
View File

@ -0,0 +1,10 @@
.. _boards-arm:
ARM Boards
##########
.. toctree::
:maxdepth: 1
:glob:
**/*

View File

@ -9,47 +9,12 @@ documented below.
To add support documentation for a new board, please use the template available
under :file:`doc/templates/board.tmpl`
X86 Boards
**********
.. toctree::
:maxdepth: 1
:glob:
:maxdepth: 2
x86/**/*
ARM Boards
**********
.. toctree::
:maxdepth: 1
:glob:
arm/**/*
ARC Boards
**********
.. toctree::
:maxdepth: 1
:glob:
arc/**/*
NIOS II Boards
**************
.. toctree::
:maxdepth: 1
:glob:
nios2/**/*
XTENSA Boards
*************
.. toctree::
:maxdepth: 1
:glob:
xtensa/**/*
x86/index.rst
arm/index.rst
arc/index.rst
nios2/index.rst
xtensa/index.rst

10
boards/nios2/index.rst Normal file
View File

@ -0,0 +1,10 @@
.. _boards-nios2:
NIOS II Boards
##############
.. toctree::
:maxdepth: 1
:glob:
**/*

10
boards/x86/index.rst Normal file
View File

@ -0,0 +1,10 @@
.. _boards-x86:
x86 Boards
##########
.. toctree::
:maxdepth: 1
:glob:
**/*

10
boards/xtensa/index.rst Normal file
View File

@ -0,0 +1,10 @@
.. _boards-xtensa:
XTENSA Boards
#############
.. toctree::
:maxdepth: 1
:glob:
**/*