doc: reorganize doc tree

With the addition of more HLD documents, the developer-guides index was
getting too busy, so push the HLD documents down a level.

Also, the supported hardware document is buried in the getting started
section and hard to find, so promote it.

Trusty isn't really supported (yet) so drop it from the TOC for now.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
This commit is contained in:
David B. Kinder 2018-07-16 15:01:25 -07:00 committed by David Kinder
parent e04255822a
commit ea0bbd509d
9 changed files with 20 additions and 10 deletions

View File

@ -1,6 +1,6 @@
.. _ACPI-virt-HLD: .. _ACPI-virt-HLD:
ACPI Virtualization High Level Design ACPI Virtualization high-level design
##################################### #####################################
ACPI introduction ACPI introduction

View File

@ -1,7 +1,7 @@
.. _APL_GVT-G-hld: .. _APL_GVT-G-hld:
Apollo Lake Intel® GVT-G high-level design GVT-G high-level design
########################################## #######################
Introduction Introduction
************ ************

View File

@ -7,14 +7,22 @@ Developer Guides
:maxdepth: 1 :maxdepth: 1
primer.rst primer.rst
../api/index.rst
../reference/kconfig/index.rst
High-Level Design Guides
************************
These documents describe the high-level design, background, and motivation for
specific areas within the ACRN hypervisor system.
.. toctree::
:maxdepth: 1
memmgt-hld.rst memmgt-hld.rst
virtio-hld.rst virtio-hld.rst
ACPI-virt-hld.rst ACPI-virt-hld.rst
APL_GVT-g-hld.rst APL_GVT-g-hld.rst
../api/index.rst
../reference/kconfig/index.rst
trusty.rst
Contributing to the project Contributing to the project
*************************** ***************************

View File

@ -1,6 +1,6 @@
.. _memmgt-hld: .. _memmgt-hld:
Memory Management High-Level Design Memory Management high-level design
################################### ###################################
This document describes memory management for the ACRN hypervisor. This document describes memory management for the ACRN hypervisor.

View File

@ -1,3 +1,5 @@
:orphan:
.. _trusty_tee: .. _trusty_tee:
Trusty TEE on ACRN Trusty TEE on ACRN

View File

@ -1,6 +1,6 @@
.. _virtio-hld: .. _virtio-hld:
Virtio High Level Design Virtio high-level design
######################## ########################
The ACRN Hypervisor follows the `Virtual I/O Device (virtio) The ACRN Hypervisor follows the `Virtual I/O Device (virtio)

View File

@ -17,6 +17,5 @@ described in :ref:`hardware`. Follow the setup guides listed here:
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
hardware.rst
apl-nuc.rst apl-nuc.rst
up2.rst up2.rst

View File

@ -26,6 +26,7 @@ Sections
introduction/index.rst introduction/index.rst
getting-started/index.rst getting-started/index.rst
hardware.rst
user-guides/index.rst user-guides/index.rst
developer-guides/index.rst developer-guides/index.rst
tutorials/index.rst tutorials/index.rst