diff --git a/doc/conf.py b/doc/conf.py index 19a51c315..084275262 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -311,8 +311,9 @@ breathe_default_members = ('members', 'undoc-members', 'content-only') # URLs must be relative to document root (with NO leading slash), # and without the html extension) html_redirect_pages = [ - ('developer-guides/index', 'contribute/index'), - ('getting-started/index', 'try/index'), - ('user-guides/index', 'develop/index'), + ('developer-guides/index', 'contribute'), + ('getting-started/index', 'try'), + ('user-guides/index', 'develop'), + ('hardware', 'reference/hardware'), ('release_notes', 'release_notes/index') ] diff --git a/doc/contribute/index.rst b/doc/contribute.rst similarity index 69% rename from doc/contribute/index.rst rename to doc/contribute.rst index 684eef486..be9fb3b85 100644 --- a/doc/contribute/index.rst +++ b/doc/contribute.rst @@ -18,13 +18,13 @@ also find details about specific architecture topics. .. toctree:: :maxdepth: 1 - ../developer-guides/modularity - ../developer-guides/hld/index - ../developer-guides/sw_design_guidelines - ../developer-guides/GVT-g-porting - ../developer-guides/trusty - ../developer-guides/l1tf - ../developer-guides/VBSK-analysis + developer-guides/modularity + developer-guides/hld/index + developer-guides/sw_design_guidelines + developer-guides/GVT-g-porting + developer-guides/trusty + developer-guides/l1tf + developer-guides/VBSK-analysis Contributing Documents @@ -39,8 +39,8 @@ the project. .. toctree:: :maxdepth: 1 - ../developer-guides/contribute_guidelines - ../developer-guides/coding_guidelines - ../developer-guides/doc_guidelines - ../developer-guides/graphviz - ../tutorials/docbuild.rst + developer-guides/contribute_guidelines + developer-guides/coding_guidelines + developer-guides/doc_guidelines + developer-guides/graphviz + tutorials/docbuild diff --git a/doc/develop.rst b/doc/develop.rst new file mode 100644 index 000000000..873b729e8 --- /dev/null +++ b/doc/develop.rst @@ -0,0 +1,63 @@ +.. _develop_acrn: + +Develop using ACRN +################## + +.. toctree:: + :maxdepth: 1 + + user-guides/acrn-shell + user-guides/kernel-parameters + user-guides/acrn-dm-parameters + user-guides/tools + +Selecting OS as a User VM +************************* + +.. toctree:: + :maxdepth: 1 + + tutorials/using_agl_as_uos + 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 + +Real time OS setup as User VM +***************************** + +.. toctree:: + :maxdepth: 1 + + tutorials/rt_linux + tutorials/using_zephyr_as_uos + +Tuning and debugging +******************** + +.. 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 diff --git a/doc/develop/index.rst b/doc/develop/index.rst deleted file mode 100644 index a3471b2fe..000000000 --- a/doc/develop/index.rst +++ /dev/null @@ -1,63 +0,0 @@ -.. _develop_acrn: - -Develop using ACRN -################## - -.. toctree:: - :maxdepth: 1 - - ../user-guides/acrn-shell.rst - ../user-guides/kernel-parameters.rst - ../user-guides/acrn-dm-parameters.rst - ../user-guides/tools.rst - -Selecting OS as a User VM -************************* - -.. toctree:: - :maxdepth: 1 - - ../tutorials/using_agl_as_uos.rst - ../tutorials/using_celadon_as_uos.rst - ../tutorials/building_uos_from_clearlinux.rst - ../tutorials/using_ubuntu_as_sos.rst - ../tutorials/using_vxworks_as_uos.rst - ../tutorials/using_windows_as_uos.rst - -Real time OS setup as User VM -***************************** - -.. toctree:: - :maxdepth: 1 - - ../tutorials/rt_linux.rst - ../tutorials/using_zephyr_as_uos.rst - -Tuning and debugging -******************** - -.. toctree:: - :maxdepth: 1 - - ../tutorials/acrn-dm_QoS.rst - ../tutorials/debug.rst - ../tutorials/increase-uos-disk-size.rst - ../tutorials/open_vswitch.rst - ../tutorials/rtvm_workload_design_guideline.rst - ../tutorials/sgx_virtualization.rst - ../tutorials/sign_clear_linux_image.rst - ../tutorials/skl-nuc.rst - ../tutorials/static-ip.rst - ../tutorials/using_cat_on_up2.rst - ../tutorials/using_partition_mode_on_nuc.rst - ../tutorials/using_partition_mode_on_up2.rst - ../tutorials/using_sbl_on_up2.rst - -Other topics -************ - -.. toctree:: - :maxdepth: 1 - - ../tutorials/agl-vms.rst - ../tutorials/trustyACRN.rst diff --git a/doc/index.rst b/doc/index.rst index 1006e3ac9..000f9b48b 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -73,10 +73,11 @@ license. :maxdepth: 1 :hidden: - learn/index - try/index - develop/index - contribute/index + Documentation Home + learn + try + develop + contribute reference/index release_notes/index faq diff --git a/doc/learn.rst b/doc/learn.rst new file mode 100644 index 000000000..20fba4e35 --- /dev/null +++ b/doc/learn.rst @@ -0,0 +1,13 @@ +.. _learn_acrn: + +Learn about ACRN +################ + +ACRN is supported on Apollo Lake and Kaby Lake Intel platforms, +as described in :ref:`hardware`. + +.. toctree:: + :maxdepth: 1 + + introduction/index + diff --git a/doc/learn/index.rst b/doc/learn/index.rst deleted file mode 100644 index d76198479..000000000 --- a/doc/learn/index.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. _learn_acrn: - -Learn about ACRN -################ - -.. toctree:: - :maxdepth: 1 - - ../introduction/index - diff --git a/doc/static/acrn-custom.css b/doc/static/acrn-custom.css index e1dd083d2..500a2696f 100644 --- a/doc/static/acrn-custom.css +++ b/doc/static/acrn-custom.css @@ -5,14 +5,14 @@ max-width: none; } -/* (temporarily) add an under development tagline to the bread crumb */ +/* (temporarily) add an under development tagline to the bread crumb .wy-breadcrumbs::after { content: " (Content reorganization in progress)"; background-color: #FFFACD; color: red; font-weight: bold; } -/* */ +*/ /* pygments tweak for white-on-black console */ diff --git a/doc/try/index.rst b/doc/try.rst similarity index 62% rename from doc/try/index.rst rename to doc/try.rst index ae9671d16..fc8b3d069 100644 --- a/doc/try/index.rst +++ b/doc/try.rst @@ -11,12 +11,14 @@ hypervisor and the `Clear Linux`_ Service OS and Guest OS on the Intel .. _Clear Linux: https://clearlinux.org -ACRN development is currently supported on Apollo Lake Intel platforms, -described in :ref:`hardware`. Follow the setup guides listed here: +ACRN is supported on Apollo Lake and Kaby Lake Intel platforms, +as described in :ref:`hardware`. + +Follow these getting started guides to give ACRN a try: .. toctree:: :maxdepth: 1 - ../getting-started/apl-nuc.rst - ../getting-started/up2.rst - ../getting-started/building-from-source.rst + getting-started/apl-nuc + getting-started/up2 + getting-started/building-from-source