linux-kernel - Re: [PATCH v2] docs: translations: add translations links when they exist

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 for Android: free password hash cracker in your pocket

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

Message-ID: <db501d4f-f922-4a78-8496-858ac528df9e@oracle.com>
Date: Fri, 15 Dec 2023 16:04:12 +0100
From: Vegard Nossum <vegard.nossum@...cle.com>
To: Jonathan Corbet <corbet@....net>
Cc: linux-doc@...r.kernel.org, Carlos Bilbao <carlos.bilbao@....com>,
        Alex Shi <alexs@...nel.org>, Hu Haowen <src.res.211@...il.com>,
        linux-kernel@...r.kernel.org, Federico Vaga <federico.vaga@...a.pv.it>,
        Jani Nikula <jani.nikula@...ux.intel.com>,
        Akira Yokosawa
 <akiyks@...il.com>, Yanteng Si <siyanteng@...ngson.cn>
Subject: Re: [PATCH v2] docs: translations: add translations links when they
 exist


On 15/12/2023 13:37, Vegard Nossum wrote:
> Add a new Sphinx extension that knows about the translations of kernel
> documentation and can insert links to the translations at the top of
> the document.
> 
> It basically works like this:
> 
> 1. Register a new node type, LanguagesNode.
> 
> 2. Register a new transform, TranslationsTransform, that inserts a new
>     LanguageNode at the top of every document. The LanguageNode contains
>     "pending references" to translations of the document. The key here
>     is that these are pending (i.e. unresolved) references that may or
>     may not actually exist.
> 
> 3. Register a 'doctree-resolved' event that iterates over all the
>     LanguageNode nodes. Any unresolved references are filtered out; the
>     list of resolved references is passed to the 'translations.html'
>     template and rendered as an HTML node (if HTML output is selected).
> 
> Testing: make htmldocs, make latexdocs with Sphinx v4.3.2 and Firefox.

Oh no, there's still a problem. If I run make htmldocs, make latexdocs,
make htmldocs, then all the translation menus disappear from the HTML.

So ignore this for now.

If anybody has a solution feel free to respond with it.


Vegard