summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorAntonin Godard <antonin.godard@bootlin.com>2024-11-06 08:48:24 +0100
committerSteve Sakoman <steve@sakoman.com>2024-11-15 06:05:32 -0800
commitfdd6df60f17c02fea53b7df6a9b802b24bf4b5c5 (patch)
tree57af158f9c14fd42fb375e7e9ac561ca158ef2a5 /documentation
parentb1ac9e9c94a94672407500bcbf80af4b23b7994a (diff)
downloadpoky-fdd6df60f17c02fea53b7df6a9b802b24bf4b5c5.tar.gz
doc: Makefile: add support for xelatex
This patch makes the "latexpdf" target compile the documentation with xelatex instead of the default pdflatex engine. The reason behind this is stated in [YOCTO #14357]: pdflatex does not support compiling foreign characters, so we need to resort to another engine, here xelatex. It also increases the texmf config buf_size to 10000000 to avoid a compilation error. (From yocto-docs rev: 0a6944b9f90b4d3babbdec9dee18fb8195b0db06) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> (cherry picked from commit 93848842b3ad8aa6b9c9f46d60f2c2ad396c6971) Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> Signed-off-by: Steve Sakoman <steve@sakoman.com>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/Makefile5
-rw-r--r--documentation/conf.py7
2 files changed, 10 insertions, 2 deletions
diff --git a/documentation/Makefile b/documentation/Makefile
index cb8d4dea85..402ad986ae 100644
--- a/documentation/Makefile
+++ b/documentation/Makefile
@@ -61,9 +61,12 @@ epub: $(PNGs)
61 $(SOURCEDIR)/set_versions.py 61 $(SOURCEDIR)/set_versions.py
62 @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) 62 @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
63 63
64# Note: we need to pass buf_size here (which is also configurable from
65# texmf.cnf), to avoid following error:
66# Unable to read an entire line---bufsize=200000. Please increase buf_size in texmf.cnf.
64latexpdf: $(PDFs) 67latexpdf: $(PDFs)
65 $(SOURCEDIR)/set_versions.py 68 $(SOURCEDIR)/set_versions.py
66 @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) 69 buf_size=10000000 $(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
67 70
68all: html epub latexpdf 71all: html epub latexpdf
69 72
diff --git a/documentation/conf.py b/documentation/conf.py
index d17860f658..b347a61c50 100644
--- a/documentation/conf.py
+++ b/documentation/conf.py
@@ -158,9 +158,14 @@ html_last_updated_fmt = '%b %d, %Y'
158# Remove the trailing 'dot' in section numbers 158# Remove the trailing 'dot' in section numbers
159html_secnumber_suffix = " " 159html_secnumber_suffix = " "
160 160
161# We need XeTeX to process special unicode character, sometimes the contributor
162# list from the release note contains those.
163# See https://docs.readthedocs.io/en/stable/guides/pdf-non-ascii-languages.html.
164latex_engine = 'xelatex'
165latex_use_xindy = False
161latex_elements = { 166latex_elements = {
162 'passoptionstopackages': '\\PassOptionsToPackage{bookmarksdepth=5}{hyperref}', 167 'passoptionstopackages': '\\PassOptionsToPackage{bookmarksdepth=5}{hyperref}',
163 'preamble': '\\setcounter{tocdepth}{2}', 168 'preamble': '\\usepackage[UTF8]{ctex}\n\\setcounter{tocdepth}{2}',
164} 169}
165 170
166# Make the EPUB builder prefer PNG to SVG because of issues rendering Inkscape SVG 171# Make the EPUB builder prefer PNG to SVG because of issues rendering Inkscape SVG