doc: additional doc navigation restructuring

Adjust doc navigation organization based on additional feedback.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
This commit is contained in:
David B. Kinder 2019-08-01 21:12:59 -07:00 committed by wenlingz
parent 34f9fec44c
commit fd2e4391ea
8 changed files with 52 additions and 47 deletions

View File

@ -132,7 +132,7 @@ language = None
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This patterns also effect to html_static_path and html_extra_path
exclude_patterns = ['_build' ]
exclude_patterns = ['_build', 'misc/README.rst' ]
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'

View File

@ -8,8 +8,8 @@ design principles, along with guidelines followed by the
development team. With this information, you too can contribute to the
project and submit code and documentation patches of your own.
Design Documents
****************
Design Guides
*************
Read about ACRN's high-level design and architecture principles that led
to the develoment of the ACRN hypervisor and its components. You'll
@ -27,8 +27,8 @@ also find details about specific architecture topics.
developer-guides/VBSK-analysis
Contributing Documents
**********************
Contributing Guides
*******************
As an open-source project, we welcome and encourage the community to
submit patches for code, documentation, tests, and more, directly to the
@ -44,3 +44,16 @@ the project.
developer-guides/doc_guidelines
developer-guides/graphviz
tutorials/docbuild
.. _tools:
Tools
*****
.. toctree::
:glob:
:maxdepth: 1
misc/tools/acrn-crashlog/README
misc/tools/**
misc/acrn-manager/**

View File

@ -3,61 +3,57 @@
Develop using ACRN
##################
Configuration Tools
*******************
- Offline configuration Tool (under developmemnt)
Configuration Tutorials
***********************
.. toctree::
:maxdepth: 1
user-guides/acrn-shell
user-guides/kernel-parameters
user-guides/acrn-dm-parameters
user-guides/tools
tutorials/increase-uos-disk-size
tutorials/sign_clear_linux_image
tutorials/static-ip
tutorials/debug
Selecting OS as a User VM
*************************
User VM Tutorials
*****************
.. toctree::
:maxdepth: 1
tutorials/using_agl_as_uos
tutorials/agl-vms
tutorials/using_celadon_as_uos
tutorials/building_uos_from_clearlinux
tutorials/using_ubuntu_as_sos
tutorials/using_vxworks_as_uos
tutorials/using_windows_as_uos
tutorials/rt_linux
tutorials/using_zephyr_as_uos
Real time OS setup as User VM
*****************************
Service VM Tutorials
********************
.. toctree::
:maxdepth: 1
tutorials/rt_linux
tutorials/using_zephyr_as_uos
tutorials/using_ubuntu_as_sos
Tuning and debugging
Enable ACRN Features
********************
.. toctree::
:maxdepth: 1
tutorials/acrn-dm_QoS
tutorials/debug
tutorials/increase-uos-disk-size
tutorials/open_vswitch
tutorials/rtvm_workload_design_guideline
tutorials/sgx_virtualization
tutorials/sign_clear_linux_image
tutorials/skl-nuc
tutorials/static-ip
tutorials/using_cat_on_up2
tutorials/using_partition_mode_on_nuc
tutorials/using_partition_mode_on_up2
tutorials/using_sbl_on_up2
Other topics
************
.. toctree::
:maxdepth: 1
tutorials/agl-vms
tutorials/trustyACRN

View File

@ -6,9 +6,11 @@ Developer references
.. toctree::
:maxdepth: 1
hardware
../api/index
../reference/kconfig/index
kconfig/index
../user-guides/acrn-shell
../user-guides/kernel-parameters
../user-guides/acrn-dm-parameters
* :ref:`glossary`
* :ref:`genindex`

View File

@ -223,6 +223,7 @@ kbd
align-items: center;
border: 1px solid #c6cbce;
background-color: #2B978F;
border-radius: 30px;
color: white;
}

View File

@ -19,6 +19,9 @@ Follow these getting started guides to give ACRN a try:
.. toctree::
:maxdepth: 1
reference/hardware
getting-started/apl-nuc
getting-started/up2
getting-started/building-from-source
tutorials/using_partition_mode_on_nuc
tutorials/using_partition_mode_on_up2

View File

@ -3,10 +3,10 @@
GPU Passthrough on Skylake NUC
##############################
.. warning::
This community reference release for the Skylake NUC with GPU
passthrough is a one-time snapshot release and is not supported
or maintained.
This community reference release for the Skylake NUC with GPU
passthrough is a one-time snapshot release and is not supported
or maintained.
Hardware platform
*****************

View File

@ -1,10 +0,0 @@
.. _tools:
Tools
#####
.. toctree::
:glob:
:maxdepth: 1
../misc/**