doc: continue doc restructuring
Changing the folder structure will cause too many broken links for external references (from other sites). So, let's put the content back where it was before the reorg, and instead use the new persona-based navigation to point to documents in the original locations. Also, introduce redirects for some documents that no longer exits. Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
4
doc/.known-issues/doc/redirect.conf
Normal file
@ -0,0 +1,4 @@
|
||||
#
|
||||
# Redirect messages
|
||||
#
|
||||
^Creating redirect:.*
|
17
doc/conf.py
@ -36,7 +36,7 @@ if "RELEASE" in os.environ:
|
||||
|
||||
sys.path.insert(0, os.path.join(os.path.abspath('.'), 'extensions'))
|
||||
extensions = ['breathe', 'sphinx.ext.graphviz', 'sphinx.ext.extlinks',
|
||||
'kerneldoc', 'eager_only']
|
||||
'kerneldoc', 'eager_only', 'html_redirects']
|
||||
|
||||
# extlinks provides a macro template
|
||||
|
||||
@ -301,3 +301,18 @@ breathe_projects = {
|
||||
}
|
||||
breathe_default_project = "Project ACRN"
|
||||
breathe_default_members = ('members', 'undoc-members', 'content-only')
|
||||
|
||||
|
||||
# Custom added feature to allow redirecting old URLs (caused by
|
||||
# reorganizing doc directories)
|
||||
#
|
||||
# list of tuples (old_url, new_url) for pages to redirect
|
||||
#
|
||||
# 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'),
|
||||
('release_notes', 'release_notes/index')
|
||||
]
|
||||
|
Before Width: | Height: | Size: 1.6 KiB |
Before Width: | Height: | Size: 16 KiB |
Before Width: | Height: | Size: 23 KiB |
Before Width: | Height: | Size: 13 KiB |
Before Width: | Height: | Size: 6.5 KiB |
@ -18,13 +18,13 @@ also find details about specific architecture topics.
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
modularity
|
||||
hld/index
|
||||
sw_design_guidelines
|
||||
GVT-g-porting
|
||||
trusty
|
||||
l1tf
|
||||
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
|
||||
|
||||
contribute_guidelines
|
||||
coding_guidelines
|
||||
doc_guidelines
|
||||
graphviz
|
||||
../developer-guides/contribute_guidelines
|
||||
../developer-guides/coding_guidelines
|
||||
../developer-guides/doc_guidelines
|
||||
../developer-guides/graphviz
|
||||
../tutorials/docbuild.rst
|
||||
|
@ -6,11 +6,10 @@ Develop using ACRN
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
building-from-source.rst
|
||||
acrn-shell.rst
|
||||
kernel-parameters.rst
|
||||
acrn-dm-parameters.rst
|
||||
tools.rst
|
||||
../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
|
||||
*************************
|
||||
|
Before Width: | Height: | Size: 81 KiB After Width: | Height: | Size: 81 KiB |
Before Width: | Height: | Size: 26 KiB After Width: | Height: | Size: 26 KiB |
Before Width: | Height: | Size: 72 KiB After Width: | Height: | Size: 72 KiB |
Before Width: | Height: | Size: 60 KiB After Width: | Height: | Size: 60 KiB |
Before Width: | Height: | Size: 34 KiB After Width: | Height: | Size: 34 KiB |
Before Width: | Height: | Size: 173 KiB After Width: | Height: | Size: 173 KiB |
Before Width: | Height: | Size: 201 KiB After Width: | Height: | Size: 201 KiB |
Before Width: | Height: | Size: 14 KiB After Width: | Height: | Size: 14 KiB |
Before Width: | Height: | Size: 147 KiB After Width: | Height: | Size: 147 KiB |
Before Width: | Height: | Size: 35 KiB After Width: | Height: | Size: 35 KiB |
Before Width: | Height: | Size: 58 KiB After Width: | Height: | Size: 58 KiB |
Before Width: | Height: | Size: 117 KiB After Width: | Height: | Size: 117 KiB |
Before Width: | Height: | Size: 166 KiB After Width: | Height: | Size: 166 KiB |
Before Width: | Height: | Size: 101 KiB After Width: | Height: | Size: 101 KiB |
Before Width: | Height: | Size: 71 KiB After Width: | Height: | Size: 71 KiB |
Before Width: | Height: | Size: 450 KiB After Width: | Height: | Size: 450 KiB |
Before Width: | Height: | Size: 62 KiB After Width: | Height: | Size: 62 KiB |
Before Width: | Height: | Size: 76 KiB After Width: | Height: | Size: 76 KiB |
Before Width: | Height: | Size: 75 KiB After Width: | Height: | Size: 75 KiB |
Before Width: | Height: | Size: 86 KiB After Width: | Height: | Size: 86 KiB |
Before Width: | Height: | Size: 34 KiB After Width: | Height: | Size: 34 KiB |
Before Width: | Height: | Size: 32 KiB After Width: | Height: | Size: 32 KiB |
Before Width: | Height: | Size: 38 KiB After Width: | Height: | Size: 38 KiB |
Before Width: | Height: | Size: 8.1 KiB After Width: | Height: | Size: 8.1 KiB |
Before Width: | Height: | Size: 20 KiB After Width: | Height: | Size: 20 KiB |
Before Width: | Height: | Size: 41 KiB After Width: | Height: | Size: 41 KiB |
Before Width: | Height: | Size: 36 KiB After Width: | Height: | Size: 36 KiB |
Before Width: | Height: | Size: 60 KiB After Width: | Height: | Size: 60 KiB |
Before Width: | Height: | Size: 37 KiB After Width: | Height: | Size: 37 KiB |
Before Width: | Height: | Size: 30 KiB After Width: | Height: | Size: 30 KiB |
Before Width: | Height: | Size: 50 KiB After Width: | Height: | Size: 50 KiB |
Before Width: | Height: | Size: 18 KiB After Width: | Height: | Size: 18 KiB |
Before Width: | Height: | Size: 54 KiB After Width: | Height: | Size: 54 KiB |
Before Width: | Height: | Size: 27 KiB After Width: | Height: | Size: 27 KiB |
Before Width: | Height: | Size: 80 KiB After Width: | Height: | Size: 80 KiB |
Before Width: | Height: | Size: 23 KiB After Width: | Height: | Size: 23 KiB |
Before Width: | Height: | Size: 23 KiB After Width: | Height: | Size: 23 KiB |
Before Width: | Height: | Size: 22 KiB After Width: | Height: | Size: 22 KiB |
Before Width: | Height: | Size: 14 KiB After Width: | Height: | Size: 14 KiB |
Before Width: | Height: | Size: 20 KiB After Width: | Height: | Size: 20 KiB |
Before Width: | Height: | Size: 25 KiB After Width: | Height: | Size: 25 KiB |
Before Width: | Height: | Size: 56 KiB After Width: | Height: | Size: 56 KiB |
Before Width: | Height: | Size: 56 KiB After Width: | Height: | Size: 56 KiB |
Before Width: | Height: | Size: 18 KiB After Width: | Height: | Size: 18 KiB |
Before Width: | Height: | Size: 42 KiB After Width: | Height: | Size: 42 KiB |
Before Width: | Height: | Size: 28 KiB After Width: | Height: | Size: 28 KiB |
Before Width: | Height: | Size: 67 KiB After Width: | Height: | Size: 67 KiB |
Before Width: | Height: | Size: 33 KiB After Width: | Height: | Size: 33 KiB |
Before Width: | Height: | Size: 57 KiB After Width: | Height: | Size: 57 KiB |
Before Width: | Height: | Size: 21 KiB After Width: | Height: | Size: 21 KiB |
Before Width: | Height: | Size: 20 KiB After Width: | Height: | Size: 20 KiB |
Before Width: | Height: | Size: 24 KiB After Width: | Height: | Size: 24 KiB |
Before Width: | Height: | Size: 115 KiB After Width: | Height: | Size: 115 KiB |
Before Width: | Height: | Size: 45 KiB After Width: | Height: | Size: 45 KiB |
Before Width: | Height: | Size: 127 KiB After Width: | Height: | Size: 127 KiB |
Before Width: | Height: | Size: 58 KiB After Width: | Height: | Size: 58 KiB |
Before Width: | Height: | Size: 99 KiB After Width: | Height: | Size: 99 KiB |