linux-kernel - [PATCH 0/2] Two cleanups for Sphinx conf.py

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Date:   Sun,  3 Sep 2017 16:12:44 -0300
From:   Mauro Carvalho Chehab <mchehab@...pensource.com>
To:     Linux Doc Mailing List <linux-doc@...r.kernel.org>,
        Jonathan Corbet <corbet@....net>
Cc:     Mauro Carvalho Chehab <mchehab@...pensource.com>,
        Mauro Carvalho Chehab <mchehab@...radead.org>,
        linux-kernel@...r.kernel.org
Subject: [PATCH 0/2] Two cleanups for Sphinx conf.py

Hi Jon,

Those patches are just cleanups for Documentation/conf.py. 

The first one removes a package usage directive for a LateX package
that it is not used. 

The second one moves some LaTeX preamble code that it is used only
on Sphinx 1.4 and 1.5 to a separate if. On Sphinx 1.6, the macros there
are silently ignored. While the conf.py becomes a little bit more complex,
it clearly marks the backward-compatible code, with IMHO, it is a
good idea, specially as some day, we may drop support for older Sphinx
versions.

None of those patches are mandatory. Feel free to apply any time you
want (or discard them, if you don't thing it is worth).

Please notice that the second patch will trivially conflict with a patch
I sent before, removing \\usepackage{adjustbox}.

I suspect that, if you apply those two patches before the one I sent eariler,
you'll avoid the conflict.

Anyway, if you apply all tree patches, you'll have a Latex 
Sphinx-independent preamble with just:

     'preamble': '''
       % Use some font with UTF-8 support with XeLaTeX
        \\usepackage{fontspec}
        \\setsansfont{DejaVu Serif}
        \\setromanfont{DejaVu Sans}
        \\setmonofont{DejaVu Sans Mono}
     '''
}

And all version-dependent preamble inserted after testing for the
Sphinx version.

Mauro Carvalho Chehab (2):
  docs-rst: conf.py: remove lscape from LaTeX preamble
  docs-rst: conf.py: only setup notice box colors if Sphinx < 1.6

 Documentation/conf.py | 65 ++++++++++++++++++++++++++++++++++-----------------
 1 file changed, 43 insertions(+), 22 deletions(-)

-- 
2.13.5