linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jani Nikula <jani.nikula@linux.intel.com>
To: Vegard Nossum <vegard.nossum@oracle.com>,
	Jonathan Corbet <corbet@lwn.net>,
	Akira Yokosawa <akiyks@gmail.com>
Cc: linux-doc@vger.kernel.org
Subject: Re: docs: "translations" extension breaks "make latexdocs" with 6.1.3<=Sphinx<7.2
Date: Tue, 13 Feb 2024 11:33:53 +0200	[thread overview]
Message-ID: <87jzn8908u.fsf@intel.com> (raw)
In-Reply-To: <8b51b6d6-0360-4f42-9b96-02e0ccd0b34f@oracle.com>

On Mon, 12 Feb 2024, Vegard Nossum <vegard.nossum@oracle.com> wrote:
> On 12/02/2024 22:52, Jonathan Corbet wrote:
>> Vegard Nossum <vegard.nossum@oracle.com> writes:
>> 
>>> On 12/02/2024 11:28, Vegard Nossum wrote:
>>>> On 12/02/2024 10:52, Akira Yokosawa wrote:
>>>>> While testing update of sphinx_pre_install WRT pyyaml, I noticed build
>>>>> errors in "make latexdocs" against Fedora 39's distro Sphinx (v6.2.1).
>>>
>>>> I think we can solve it by making 'current_language' a true element
>>>> attribute:
>>> [...]
>>>> This is probably more correct anyway.
>>>>
>>>> I'll test this more thoroughly with a full build as I think translations
>>>> won't show up when using SPHINXDIRS= (because the translation is outside
>>>> the source tree) as well as with older/newer Sphinx versions.
>>>
>>> In the end, that first patch caused errors on Sphinx 4.x
>>> ("TypeError: LanguagesNode.__init__() got multiple values for argument
>>> 'current_language'").
>>>
>>> This seems to work across 2.x/3.x/6.x/7.x for me:
>> 
>> It occurs to me that me we should just have conf.py just not load the
>> translations extension at all if the builder is not "html"?
>
> I think we need to, otherwise it will have one of those issues that were
> discovered during the original submission: if you 'make latexdocs'
> first, then 'make htmldocs', the Translations nodes just won't be in the
> saved doctrees and won't be there for the HTML output.

"Note that the current builder tag is not available in conf.py, as it is
created after the builder is initialized."

https://www.sphinx-doc.org/en/master/usage/configuration.html


BR,
Jani.


-- 
Jani Nikula, Intel

  reply	other threads:[~2024-02-13  9:33 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-02-12  9:52 docs: "translations" extension breaks "make latexdocs" with 6.1.3<=Sphinx<7.2 Akira Yokosawa
2024-02-12 10:28 ` Vegard Nossum
2024-02-12 12:26   ` Vegard Nossum
2024-02-12 21:52     ` Jonathan Corbet
2024-02-12 22:04       ` Vegard Nossum
2024-02-13  9:33         ` Jani Nikula [this message]
2024-02-13 14:34           ` Jonathan Corbet

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87jzn8908u.fsf@intel.com \
    --to=jani.nikula@linux.intel.com \
    --cc=akiyks@gmail.com \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=vegard.nossum@oracle.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).