mirror of
https://github.com/projectacrn/acrn-hypervisor.git
synced 2025-09-10 13:19:31 +00:00
doc: clean up PDF generation for ACRN docs
PRs #5945 and #5949 introduced fixes to the doc building process to support PDF generation of the documentation set. This PR refines the doc build process, cleaning up the Makefile, adding display of tool version information, and updates the doc building documentation to include additional dependencies needed for building the PDF and instructions for how to build the PDF. The latexpdf make target is provided to just run the latex and PDF producing process that depends on the HTML artifacts from a make html run. A new make pdf target is provided that combines the two steps into one. A new know-issues pattern file is added that verifies the expected output from the latexpdf process is returned, as it can't be completely eliminated without losing potential error messages that need to be resolved. Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
This commit is contained in:
committed by
David Kinder
parent
b96d23a68f
commit
0e317d56bf
19
doc/conf.py
19
doc/conf.py
@@ -293,7 +293,25 @@ latex_elements = {
|
||||
#
|
||||
'preamble': r'''
|
||||
\setcounter{tocdepth}{3}
|
||||
\renewcommand\_{\textunderscore\allowbreak}
|
||||
\usepackage{listings}
|
||||
\usepackage{xcolor}
|
||||
\definecolor{IntelMNBlue}{HTML}{003C71}
|
||||
\usepackage{titlesec}
|
||||
\title{\normalfont\\color{IntelMNBlue}}
|
||||
\usepackage{colortbl}
|
||||
\protected\def\sphinxstyletheadfamily{\cellcolor[HTML]{DCDCDC}\sffamily\bfseries\color{IntelMNBlue}}
|
||||
''',
|
||||
'sphinxsetup': 'hmargin={0.7in,0.7in}, vmargin={1in,1in},\
|
||||
verbatimwithframe=true,\
|
||||
verbatimwrapslines=true,\
|
||||
TitleColor={HTML}{003C71},\
|
||||
HeaderFamily=\\rmfamily\\bfseries, \
|
||||
InnerLinkColor={HTML}{003C71},\
|
||||
OuterLinkColor={HTML}{003C71},\
|
||||
VerbatimColor={HTML}{F0F0F0},\
|
||||
VerbatimHighlightColor={HTML}{76CEFF},\
|
||||
VerbatimBorderColor={HTML}{00285A}',
|
||||
|
||||
# Latex figure (float) alignment
|
||||
#
|
||||
@@ -308,6 +326,7 @@ latex_documents = [
|
||||
u'Project ACRN', 'manual'),
|
||||
]
|
||||
|
||||
latex_logo = 'images/ACRN_Logo_PrimaryLockup_COLOR-300x300-1.png'
|
||||
|
||||
# -- Options for manual page output ---------------------------------------
|
||||
|
||||
|
Reference in New Issue
Block a user