Groups > linux.debian.maint.python > #14507

Bug#998059: sphinx: LANGUAGE environment variable inconsistently affects output of objects.inv

Path	csiph.com!aioe.org!news.servidellagleba.it!bofh.it!news.nic.it!robomod
From	James Addison <jay@jp-hosting.net>
Newsgroups	linux.debian.bugs.dist, linux.debian.maint.python
Subject	Bug#998059: sphinx: LANGUAGE environment variable inconsistently affects output of objects.inv
Date	Sun, 02 Oct 2022 14:30:01 +0200
Message-ID	<Fc6gx-bxCQ-1@gated-at.bofh.it> (permalink)
References	<Ddw3E-2rP-9@gated-at.bofh.it>
X-Mailbox-Line	From debian-bugs-dist-request@lists.debian.org Sun Oct 2 12:21:11 2022
Old-Return-Path	<debbugs@buxtehude.debian.org>
X-Spam-Flag	NO
X-Spam-Score	-3.95
Reply-To	James Addison <jay@jp-hosting.net>, 998059@bugs.debian.org
Resent-To	debian-bugs-dist@lists.debian.org
Resent-Cc	debian-python@lists.debian.org, Debian Python Team <team+python@tracker.debian.org>
X-Debian-Pr-Message	followup 998059
X-Debian-Pr-Package	sphinx
X-Debian-Pr-Source	sphinx
Content-Type	text/plain; charset="us-ascii"
MIME-Version	1.0
Content-Transfer-Encoding	7bit
X-Mailer	reportbug 7.10.3+deb11u1
X-Debian-Message	from BTS
X-Mailing-List	<debian-bugs-dist@lists.debian.org> archive/latest/1737127
List-ID	<debian-bugs-dist.lists.debian.org>
List-URL	<https://lists.debian.org/debian-bugs-dist/>
Approved	robomod@news.nic.it
Lines	23
Organization	linux.* mail to news gateway
Sender	robomod@news.nic.it
X-Original-Date	Sun, 02 Oct 2022 13:17:39 +0100
X-Original-Message-ID	<166471305917.2834.7961584496216902097.reportbug@point>
X-Original-References	<163549749695.768269.2955803058750044552@copycat>
Xref	csiph.com linux.debian.bugs.dist:1119570 linux.debian.maint.python:14507

Cross-posted to 2 groups.

Show key headers only | View raw

Source: sphinx
Followup-For: Bug #998059
X-Debbugs-Cc: debian-python@lists.debian.org

(context: cross-posting based on an idea[1] that has been discussed upstream in sphinx's GitHub repository about how to resolve locale-based build variance)

The SPHINXOPTS[2] environment variable provides a way to selectively override defined environment variables (such as LANGUAGE) in a way that should only affect sphinx (limiting the effects on unrelated build steps).

For example:

  SPHINXOPTS='-D LANGUAGE="en_US.UTF-8"'

That would allow the objects.inv file to be built in a fixed language on a per-package basis.

It doesn't seem ideal to artificially limit documentation localization for affected packages, but could allow many of the affected packages to pass diffoscope reproducibility testing.

Alternatives explored: I wasn't able to identify a straightforward, supported way to disable creation of the objects.inv file, nor is it currently possible to invoke a multi-locale HTML sphinx build (an approach that might permit output of monolithic documentation outputs that wouldn't vary based on build environment locale).  I'll file a feature request for the former; the latter is tracked by an existing request[3].

[1] - https://github.com/sphinx-doc/sphinx/issues/9778#issuecomment-1264065231

[2] - https://github.com/sphinx-doc/sphinx/blob/v4.5.0/doc/man/sphinx-build.rst#environment-variables

[3] - https://github.com/sphinx-doc/sphinx/issues/788

Back to linux.debian.maint.python | Previous | Next | Find similar | Unroll thread

Thread

Bug#998059: sphinx: LANGUAGE environment variable inconsistently affects output of objects.inv James Addison <jay@jp-hosting.net> - 2022-10-02 14:30 +0200

csiph-web