summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorQuentin Schulz <quentin.schulz@theobroma-systems.com>2024-03-28 16:07:14 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2024-04-08 14:36:38 +0100
commite802b06490badb78ecb48e7e79a92eea6058f7c0 (patch)
tree69763c2c758d87e43c3508d62d2cea13a1f49ab0 /documentation
parent251b5f7a06a1d3d4429621c87d7521f3d446cf76 (diff)
downloadpoky-e802b06490badb78ecb48e7e79a92eea6058f7c0.tar.gz
docs: conf.py: properly escape backslashes for latex_elements
There are some syntax warnings returned by Python: """ yocto-docs/documentation/conf.py:162: SyntaxWarning: invalid escape sequence '\P' 'passoptionstopackages': '\PassOptionsToPackage{bookmarksdepth=5}{hyperref}', yocto-docs/documentation/conf.py:163: SyntaxWarning: invalid escape sequence '\s' 'preamble': '\setcounter{tocdepth}{2}', """ Backslashes must be doubled in Python string literals to avoid interpretation as escape sequence, c.f. https://www.sphinx-doc.org/en/master/latex.html#module-latex. Cc: Quentin Schulz <foss+yocto@0leil.net> (From yocto-docs rev: a78d9bde7f90f860aa969b7d8e47350de9106183) Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com> Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/conf.py4
1 files changed, 2 insertions, 2 deletions
diff --git a/documentation/conf.py b/documentation/conf.py
index a64685ec9b..35c5c14535 100644
--- a/documentation/conf.py
+++ b/documentation/conf.py
@@ -159,8 +159,8 @@ html_last_updated_fmt = '%b %d, %Y'
159html_secnumber_suffix = " " 159html_secnumber_suffix = " "
160 160
161latex_elements = { 161latex_elements = {
162 'passoptionstopackages': '\PassOptionsToPackage{bookmarksdepth=5}{hyperref}', 162 'passoptionstopackages': '\\PassOptionsToPackage{bookmarksdepth=5}{hyperref}',
163 'preamble': '\setcounter{tocdepth}{2}', 163 'preamble': '\\setcounter{tocdepth}{2}',
164} 164}
165 165
166# Make the EPUB builder prefer PNG to SVG because of issues rendering Inkscape SVG 166# Make the EPUB builder prefer PNG to SVG because of issues rendering Inkscape SVG