doc: fix failure to make pdf output for project docs
The "make pdf" processing doesn't handle .svg files that were introduced for the config option documentation. Change these images to .png instead. The "make pdf" processing tools produce slightly different log output. Tweak the "known issue" processing script (that removes messages from the sphinx_build output for known issues that we can safely ignore. Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
@ -3,7 +3,7 @@
|
||||
#
|
||||
^WARNING: Not copying tabs assets! Not compatible with latex builder
|
||||
#
|
||||
^Latexmk: Summary of warnings:
|
||||
^Latexmk: Summary of warnings.*:
|
||||
^ Latex failed to resolve [0-9]+ reference\(s\)
|
||||
^ Latex failed to resolve [0-9]+ citation\(s\)
|
||||
#
|
||||
@ -20,3 +20,7 @@
|
||||
^ =====Latex reported missing or unavailable character\(s\).
|
||||
^=====See log file for details.
|
||||
#
|
||||
^Collected error summary \(may duplicate other messages\):
|
||||
^ pdflatex: Command for 'pdflatex' gave return code 1
|
||||
^ Refer to 'acrn.log' for details
|
||||
#
|
||||
|
@ -13,7 +13,7 @@ SPHINXBUILD = sphinx-build
|
||||
SPHINXPROJ = "Project ACRN"
|
||||
BUILDDIR ?= _build
|
||||
SOURCEDIR = $(BUILDDIR)/rst
|
||||
LATEXMKOPTS = -silent
|
||||
LATEXMKOPTS = "-silent -interaction=nonstopmode -f"
|
||||
|
||||
# document publication assumes the folder structure is setup
|
||||
# with the acrn-hypervisor and projectacrn.github.io repos as
|
||||
@ -69,7 +69,7 @@ singlehtml: content doxy
|
||||
|
||||
pdf: html
|
||||
@echo now making $(BUILDDIR)/latex/acrn.pdf
|
||||
-$(Q)make -silent latexpdf LATEXMKOPTS=$(LATEXMKOPTS) >> $(BUILDDIR)/doc.log 2>&1
|
||||
$(Q)make -silent latexpdf LATEXMKOPTS=$(LATEXMKOPTS) >> $(BUILDDIR)/doc.log 2>&1
|
||||
$(Q)./scripts/filter-doc-log.sh $(BUILDDIR)/doc.log
|
||||
|
||||
|
||||
|
@ -319,7 +319,7 @@ VerbatimBorderColor={HTML}{00285A}',
|
||||
# author, documentclass [howto, manual, or own class]).
|
||||
latex_documents = [
|
||||
(master_doc, 'acrn.tex', u'Project ACRN Documentation',
|
||||
u'Project ACRN', 'manual'),
|
||||
u'Project ACRN', 'manual',True),
|
||||
]
|
||||
|
||||
latex_logo = 'images/ACRN_Logo_PrimaryLockup_COLOR-300x300-1.png'
|
||||
|
@ -37,19 +37,19 @@ String
|
||||
|
||||
.. comment These images are used in generated option documentation
|
||||
|
||||
.. |icon-advanced| image:: images/Advanced.svg
|
||||
.. |icon-advanced| image:: images/Advanced.png
|
||||
:alt: Find this option on the Configurator's Advanced Parameters tab
|
||||
.. |icon-basic| image:: images/Basic.svg
|
||||
.. |icon-basic| image:: images/Basic.png
|
||||
:alt: Find this option on the Configurator's Basic Parameters tab
|
||||
.. |icon-not-available| image:: images/Not-available.svg
|
||||
.. |icon-not-available| image:: images/Not-available.png
|
||||
:alt: This is a hidden option and not user-editable using the Configurator
|
||||
.. |icon-post-launched-vm| image:: images/Post-launched-VM.svg
|
||||
.. |icon-post-launched-vm| image:: images/Post-launched-VM.png
|
||||
:alt: Find this option on a Configurator Post-launched VM tab
|
||||
.. |icon-pre-launched-vm| image:: images/Pre-launched-VM.svg
|
||||
.. |icon-pre-launched-vm| image:: images/Pre-launched-VM.png
|
||||
:alt: Find this option on a Configurator Pre-launched VM tab
|
||||
.. |icon-service-vm| image:: images/Service-VM.svg
|
||||
.. |icon-service-vm| image:: images/Service-VM.png
|
||||
:alt: Find this option on the Configurator Service VM tab
|
||||
.. |icon-hypervisor| image:: images/Hypervisor.svg
|
||||
.. |icon-hypervisor| image:: images/Hypervisor.png
|
||||
:alt: Find this option on the Configurator's Hypervisor Global Settings tab
|
||||
|
||||
We use icons within an option description to indicate where the option can be
|
||||
|
BIN
doc/reference/images/Advanced.png
Normal file
After Width: | Height: | Size: 1.7 KiB |
BIN
doc/reference/images/Basic.png
Normal file
After Width: | Height: | Size: 1.5 KiB |
BIN
doc/reference/images/Hypervisor.png
Normal file
After Width: | Height: | Size: 1.3 KiB |
BIN
doc/reference/images/Not-available.png
Normal file
After Width: | Height: | Size: 1.5 KiB |
BIN
doc/reference/images/Post-launched-VM.png
Normal file
After Width: | Height: | Size: 1.8 KiB |
BIN
doc/reference/images/Pre-launched-VM.png
Normal file
After Width: | Height: | Size: 1.7 KiB |
BIN
doc/reference/images/Service-VM.png
Normal file
After Width: | Height: | Size: 1.3 KiB |