github/acrn-hypervisor
1
0
Fork 0
mirror of https://github.com/projectacrn/acrn-hypervisor.git synced 2025-04-28 11:43:56 +00:00
Code Issues Projects Releases Wiki Activity

doc: prep for Ubuntu 22.04

Browse Source 
These changes are compatible with both the Ubuntu 20.04 and 22.04
documentation build processes.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
This commit is contained in:
David B. Kinder 2022-10-18 14:40:41 -07:00 committed by David Kinder
parent ee0a1b0f1c
commit 4b6c782726
4 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/.known-issues/doc/pdf.conf
View File

@ -24,3 +24,7 @@
^ pdflatex: Command for 'pdflatex' gave return code 1 ^ pdflatex: Command for 'pdflatex' gave return code 1
^ Refer to 'acrn.log' for details ^ Refer to 'acrn.log' for details
# #
^Rc files read:
^ /etc/LatexMk
^ latexmkrc
#

2
doc/Makefile
View File

@ -13,7 +13,7 @@ SPHINXBUILD = sphinx-build
SPHINXPROJ = "Project ACRN" SPHINXPROJ = "Project ACRN"
BUILDDIR ?= _build BUILDDIR ?= _build
SOURCEDIR = $(BUILDDIR)/rst SOURCEDIR = $(BUILDDIR)/rst
LATEXMKOPTS = -silent LATEXMKOPTS = "-silent -f"
# should the config option doc show hidden config options? # should the config option doc show hidden config options?
XSLTPARAM ?= --stringparam showHidden 'n' XSLTPARAM ?= --stringparam showHidden 'n'

4
doc/acrn.doxyfile
View File

@ -246,7 +246,7 @@ ALIASES += "endrst=\endverbatim"
# A mapping has the form "name=value". For example adding "class=itcl::class" # A mapping has the form "name=value". For example adding "class=itcl::class"
# will allow you to use the command class in the itcl::class meaning. # will allow you to use the command class in the itcl::class meaning.
TCL_SUBST = # TCL_SUBST =
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
# only. Doxygen will then generate output that is more tailored for C. For # only. Doxygen will then generate output that is more tailored for C. For
@ -1104,7 +1104,7 @@ ALPHABETICAL_INDEX = YES
# Minimum value: 1, maximum value: 20, default value: 5. # Minimum value: 1, maximum value: 20, default value: 5.
# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. # This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
COLS_IN_ALPHA_INDEX = 5 # COLS_IN_ALPHA_INDEX = 5
# In case all classes in a project start with a common prefix, all classes will # In case all classes in a project start with a common prefix, all classes will
# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag

2
doc/custom-doxygen/mainpage.md
View File

@ -1,4 +1,4 @@
# API Documentation {#index} # API Documentation {#mainpage}
Project ACRN is a flexible and lighweight hypervisor, built with Project ACRN is a flexible and lighweight hypervisor, built with
real-time and safety-criticality in mind. It streamlines real-time and safety-criticality in mind. It streamlines