[all] Failure to build (FTBFS) with Sphinx 5.0 and docutils 0.18

Jeremy Stanley fungi at yuggoth.org
Fri Jun 24 14:16:21 UTC 2022

On 2022-06-24 14:56:59 +0200 (+0200), Thomas Goirand wrote:
> I'd appreciate a bit of help from the OpenStack project here, to fix these
> before Sphinx 5 and Docutils 0.18 are uploaded to Debian Unstable.
> If you do have a fix, a quick link in these bug reports would be lovely.

Yes, it looks like https://review.opendev.org/846848 (autoproposed)
is attempting to update our constraints for Sphinx from 4.5.0 to
5.0.2 (though keeping docutils 0.17.1 at the moment, presumably due
to a transitive version cap somewhere in the dependency set) and is
failing its cross-osc-tox-docs canary build with the following:

    Warning, treated as error: extlinks: Sphinx-6.0 will require a
    caption string to contain exactly one '%s' and all other '%'
    need to be escaped as '%%'.

Unfortunately that's not an easy condition to scan our entire
codebase for (captions with more or fewer than one '%s' in them), so
it's hard to know how widespread the problem is.

Looking at the bug you linked for the nova package build, it seems
like that's a got unit a test failure unrelated to Sphinx or
docutils. Are you sure it's related?

For the os-api-ref bug, that seems to be an API response mismatch in
its tests. I can't say for sure without looking deeper that the
tests don't use Sphinx or docutils to generate the HTML involved,
but it's not clear to me that's the cause at least.

The openstacksdk bug similarly appears to be for a unit test
failure, something to do with tempfile handling I think, not
documentation building.

The cloudkitty bug does look like a problem with the documentation
source being incompatible with Sphinx involving the wsmeext
extension, so different than we're seeing on the requirements tests
at least.

The dogpile.cache and repoze.who bugs also look Sphinx-related,
though the OpenStack community doesn't develop those projects so
someone will probably need to reach out to them wherever they
collaborate officially.
Jeremy Stanley
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 963 bytes
Desc: not available
URL: <http://lists.openstack.org/pipermail/openstack-discuss/attachments/20220624/4b381ad1/attachment.sig>

More information about the openstack-discuss mailing list