Skip to content

Commit fd2e439

Browse files
dbkinderwenlingz
authored andcommitted
doc: additional doc navigation restructuring
Adjust doc navigation organization based on additional feedback. Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
1 parent 34f9fec commit fd2e439

File tree

8 files changed

+52
-47
lines changed

8 files changed

+52
-47
lines changed

doc/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@
132132
# List of patterns, relative to source directory, that match files and
133133
# directories to ignore when looking for source files.
134134
# This patterns also effect to html_static_path and html_extra_path
135-
exclude_patterns = ['_build' ]
135+
exclude_patterns = ['_build', 'misc/README.rst' ]
136136

137137
# The name of the Pygments (syntax highlighting) style to use.
138138
pygments_style = 'sphinx'

doc/contribute.rst

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ design principles, along with guidelines followed by the
88
development team. With this information, you too can contribute to the
99
project and submit code and documentation patches of your own.
1010

11-
Design Documents
12-
****************
11+
Design Guides
12+
*************
1313

1414
Read about ACRN's high-level design and architecture principles that led
1515
to the develoment of the ACRN hypervisor and its components. You'll
@@ -27,8 +27,8 @@ also find details about specific architecture topics.
2727
developer-guides/VBSK-analysis
2828

2929

30-
Contributing Documents
31-
**********************
30+
Contributing Guides
31+
*******************
3232

3333
As an open-source project, we welcome and encourage the community to
3434
submit patches for code, documentation, tests, and more, directly to the
@@ -44,3 +44,16 @@ the project.
4444
developer-guides/doc_guidelines
4545
developer-guides/graphviz
4646
tutorials/docbuild
47+
48+
.. _tools:
49+
50+
Tools
51+
*****
52+
53+
.. toctree::
54+
:glob:
55+
:maxdepth: 1
56+
57+
misc/tools/acrn-crashlog/README
58+
misc/tools/**
59+
misc/acrn-manager/**

doc/develop.rst

Lines changed: 22 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -3,61 +3,57 @@
33
Develop using ACRN
44
##################
55

6+
7+
Configuration Tools
8+
*******************
9+
10+
- Offline configuration Tool (under developmemnt)
11+
12+
Configuration Tutorials
13+
***********************
14+
615
.. toctree::
716
:maxdepth: 1
817

9-
user-guides/acrn-shell
10-
user-guides/kernel-parameters
11-
user-guides/acrn-dm-parameters
12-
user-guides/tools
18+
tutorials/increase-uos-disk-size
19+
tutorials/sign_clear_linux_image
20+
tutorials/static-ip
21+
tutorials/debug
1322

14-
Selecting OS as a User VM
15-
*************************
23+
User VM Tutorials
24+
*****************
1625

1726
.. toctree::
1827
:maxdepth: 1
1928

2029
tutorials/using_agl_as_uos
30+
tutorials/agl-vms
2131
tutorials/using_celadon_as_uos
2232
tutorials/building_uos_from_clearlinux
23-
tutorials/using_ubuntu_as_sos
2433
tutorials/using_vxworks_as_uos
2534
tutorials/using_windows_as_uos
35+
tutorials/rt_linux
36+
tutorials/using_zephyr_as_uos
2637

27-
Real time OS setup as User VM
28-
*****************************
38+
Service VM Tutorials
39+
********************
2940

3041
.. toctree::
3142
:maxdepth: 1
3243

33-
tutorials/rt_linux
34-
tutorials/using_zephyr_as_uos
44+
tutorials/using_ubuntu_as_sos
3545

36-
Tuning and debugging
46+
Enable ACRN Features
3747
********************
3848

3949
.. toctree::
4050
:maxdepth: 1
4151

4252
tutorials/acrn-dm_QoS
43-
tutorials/debug
44-
tutorials/increase-uos-disk-size
4553
tutorials/open_vswitch
4654
tutorials/rtvm_workload_design_guideline
4755
tutorials/sgx_virtualization
48-
tutorials/sign_clear_linux_image
4956
tutorials/skl-nuc
50-
tutorials/static-ip
5157
tutorials/using_cat_on_up2
52-
tutorials/using_partition_mode_on_nuc
53-
tutorials/using_partition_mode_on_up2
5458
tutorials/using_sbl_on_up2
55-
56-
Other topics
57-
************
58-
59-
.. toctree::
60-
:maxdepth: 1
61-
62-
tutorials/agl-vms
6359
tutorials/trustyACRN

doc/reference/index.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,11 @@ Developer references
66
.. toctree::
77
:maxdepth: 1
88

9-
hardware
109
../api/index
11-
../reference/kconfig/index
10+
kconfig/index
11+
../user-guides/acrn-shell
12+
../user-guides/kernel-parameters
13+
../user-guides/acrn-dm-parameters
1214

1315
* :ref:`glossary`
1416
* :ref:`genindex`

doc/static/acrn-custom.css

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -223,6 +223,7 @@ kbd
223223
align-items: center;
224224
border: 1px solid #c6cbce;
225225
background-color: #2B978F;
226+
border-radius: 30px;
226227
color: white;
227228
}
228229

doc/try.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@ Follow these getting started guides to give ACRN a try:
1919
.. toctree::
2020
:maxdepth: 1
2121

22+
reference/hardware
2223
getting-started/apl-nuc
2324
getting-started/up2
2425
getting-started/building-from-source
26+
tutorials/using_partition_mode_on_nuc
27+
tutorials/using_partition_mode_on_up2

doc/tutorials/skl-nuc.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
GPU Passthrough on Skylake NUC
44
##############################
55

6-
.. warning::
7-
This community reference release for the Skylake NUC with GPU
8-
passthrough is a one-time snapshot release and is not supported
9-
or maintained.
6+
7+
This community reference release for the Skylake NUC with GPU
8+
passthrough is a one-time snapshot release and is not supported
9+
or maintained.
1010

1111
Hardware platform
1212
*****************

doc/user-guides/tools.rst

Lines changed: 0 additions & 10 deletions
This file was deleted.

0 commit comments

Comments
 (0)