[1/3] conf.py: properly escape backslashes for latex_elements

From: Quentin Schulz <quentin.schulz@theobroma-systems.com>

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>
Signed-off-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
---
 documentation/conf.py | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Hi Quentin

Thanks for the patch!

On 3/28/24 at 16:07, Quentin Schulz wrote:
> From: Quentin Schulz <quentin.schulz@theobroma-systems.com>
>
> 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.

What command(s) were you running to get the error? I didn't see it.
Anyway:
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Merged into "master-next"
Cheers
Michael.

Hi Michael,

On 3/29/24 12:12, Michael Opdenacker wrote:
> Hi Quentin
> 
> Thanks for the patch!
> 
> On 3/28/24 at 16:07, Quentin Schulz wrote:
>> From: Quentin Schulz <quentin.schulz@theobroma-systems.com>
>>
>> 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.
> 
> What command(s) were you running to get the error? I didn't see it.

Normal build instructions, just using Python 3.12.2 on Fedora 39.

https://docs.python.org/3/whatsnew/3.12.html#other-language-changes

"""
A backslash-character pair that is not a valid escape sequence now 
generates a SyntaxWarning, instead of DeprecationWarning. For example, 
re.compile("\d+\.\d+") now emits a SyntaxWarning ("\d" is an invalid 
escape sequence, use raw strings for regular expression: 
re.compile(r"\d+\.\d+")). In a future Python version, SyntaxError will 
eventually be raised, instead of SyntaxWarning. (Contributed by Victor 
Stinner in gh-98401.)
"""

Cheers,
Quentin