Bug 728810 – dev-python/sphinx-3.0.4[doc]: CONTRIBUTING.rst:410:undefined label: python:describing-warning-filters (if the link has no caption the label must precede a section header)

• Status: RESOLVED FIXED
• Product: Gentoo Linux

[Description Rolf Eike Beer 2020-06-19 18:54:43 UTC]

Created attachment 645268 [details]
build.log

Portage 2.3.99 (python 3.7.7-final-0, default/linux/hppa/17.0, gcc-9.3.0, glibc-2.30-r8, 5.7.2-gentoo-parisc64 parisc64)
=================================================================
System uname: Linux-5.7.2-gentoo-parisc64-parisc64-PA8800_-Mako-with-gentoo-2.6
KiB Mem:     8230136 total,   3312464 free
KiB Swap:    4194300 total,   4194300 free
Timestamp of repository gentoo: Fri, 19 Jun 2020 06:45:01 +0000
Head commit of repository gentoo: 3e90512c83b68e0011dd94c573e22866c8927abb
sh bash 4.4_p23-r1
ld GNU ld (Gentoo 2.33.1 p2) 2.33.1
app-shells/bash:          4.4_p23-r1::gentoo
dev-lang/perl:            5.30.3::gentoo
dev-lang/python:          2.7.18::gentoo, 3.6.10-r2::gentoo, 3.7.7-r2::gentoo, 3.8.2-r2::gentoo
dev-util/cmake:           3.16.5::gentoo
sys-apps/baselayout:      2.6-r1::gentoo
sys-apps/openrc:          0.42.1::gentoo
sys-apps/sandbox:         2.18::gentoo
sys-devel/autoconf:       2.69-r4::gentoo
sys-devel/automake:       1.16.1-r1::gentoo
sys-devel/binutils:       2.33.1-r1::gentoo
sys-devel/gcc:            9.3.0::gentoo
sys-devel/gcc-config:     2.1::gentoo
sys-devel/libtool:        2.4.6-r6::gentoo
sys-devel/make:           4.2.1-r4::gentoo
sys-kernel/linux-headers: 5.4-r1::gentoo (virtual/os-headers)
sys-libs/glibc:           2.30-r8::gentoo
Repositories:

gentoo
    location: /usr/portage
    sync-type: rsync
    sync-uri: rsync://rsync.gentoo.org/gentoo-portage
    priority: -1000
    sync-rsync-verify-metamanifest: no
    sync-rsync-verify-max-age: 24
    sync-rsync-extra-opts: 
    sync-rsync-verify-jobs: 1

ACCEPT_KEYWORDS="hppa"
ACCEPT_LICENSE="@FREE"
CBUILD="hppa2.0-unknown-linux-gnu"
CFLAGS="-O2 -pipe -march=2.0"
CHOST="hppa2.0-unknown-linux-gnu"
CONFIG_PROTECT="/etc /usr/share/gnupg/qualified.txt"
CONFIG_PROTECT_MASK="/etc/ca-certificates.conf /etc/env.d /etc/fonts/fonts.conf /etc/gconf /etc/gentoo-release /etc/revdep-rebuild /etc/sandbox.d /etc/terminfo"
CXXFLAGS="-O2 -pipe -march=2.0"
DISTDIR="/usr/portage/distfiles"
ENV_UNSET="DBUS_SESSION_BUS_ADDRESS DISPLAY GOBIN GOPATH PERL5LIB PERL5OPT PERLPREFIX PERL_CORE PERL_MB_OPT PERL_MM_OPT XAUTHORITY XDG_CACHE_HOME XDG_CONFIG_HOME XDG_DATA_HOME XDG_RUNTIME_DIR"
FCFLAGS=""
FEATURES="assume-digests binpkg-docompress binpkg-dostrip binpkg-logs config-protect-if-modified distlocks ebuild-locks fixlafiles ipc-sandbox merge-sync multilib-strict network-sandbox news parallel-fetch pid-sandbox preserve-libs protect-owned qa-unresolved-soname-deps sandbox sfperms strict unknown-features-warn unmerge-logs unmerge-orphans userfetch userpriv usersandbox usersync xattr"
FFLAGS=""
GENTOO_MIRRORS="ftp://castor.sf-tec.de/ ftp://ftp.join.uni-muenster.de/pub/linux/distributions/gentoo ftp://ftp.wh2.tu-dresden.de/pub/mirrors/gentoo "
LANG="en_US.UTF-8"
LDFLAGS="-Wl,-O1 -Wl,--as-needed"
PKGDIR="/usr/portage/packages"
PORTAGE_CONFIGROOT="/"
PORTAGE_RSYNC_OPTS="--recursive --links --safe-links --perms --times --omit-dir-times --compress --force --whole-file --delete --stats --human-readable --timeout=180 --exclude=/distfiles --exclude=/local --exclude=/packages --exclude=/.git"
PORTAGE_TMPDIR="/var/tmp"
USE="acl berkdb big-endian bzip2 cli crypt cups firefox foomaticdb fortran gdbm gpm hppa iconv imlib ipv6 libwww ncurses nls nptl openmp pam pcre readline seccomp spell split-usr ssl tcpd unicode xattr zlib" ADA_TARGET="gnat_2018" APACHE2_MODULES="authn_core authz_core socache_shmcb unixd actions alias auth_basic authn_alias authn_anon authn_dbm authn_default authn_file authz_dbm authz_default authz_groupfile authz_host authz_owner authz_user autoindex cache cgi cgid dav dav_fs dav_lock deflate dir disk_cache env expires ext_filter file_cache filter headers include info log_config logio mem_cache mime mime_magic negotiation rewrite setenvif speling status unique_id userdir usertrack vhost_alias" CALLIGRA_FEATURES="karbon sheets words" COLLECTD_PLUGINS="df interface irq load memory rrdtool swap syslog" ELIBC="glibc" GPSD_PROTOCOLS="ashtech aivdm earthmate evermore fv18 garmin garmintxt gpsclock greis isync itrax mtk3301 nmea ntrip navcom oceanserver oldstyle oncore rtcm104v2 rtcm104v3 sirf skytraq superstar2 timing tsip tripmate tnt ublox ubx" INPUT_DEVICES="libinput" KERNEL="linux" LCD_DEVICES="bayrad cfontz cfontz633 glk hd44780 lb216 lcdm001 mtxorb ncurses text" LIBREOFFICE_EXTENSIONS="presenter-console presenter-minimizer" OFFICE_IMPLEMENTATION="libreoffice" PHP_TARGETS="php7-2" POSTGRES_TARGETS="postgres10 postgres11" PYTHON_SINGLE_TARGET="python3_7" PYTHON_TARGETS="python2_7 python3_7" RUBY_TARGETS="ruby25" USERLAND="GNU" VIDEO_CARDS="fbdev dummy v4l" XTABLES_ADDONS="quota2 psd pknock lscan length2 ipv4options ipset ipp2p iface geoip fuzzy condition tee tarpit sysrq steal rawnat logmark ipmark dhcpmac delude chaos account"
Unset:  CC, CPPFLAGS, CTARGET, CXX, EMERGE_DEFAULT_OPTS, INSTALL_MASK, LC_ALL, LINGUAS, MAKEOPTS, PORTAGE_BINHOST, PORTAGE_BUNZIP2_COMMAND, PORTAGE_COMPRESS, PORTAGE_COMPRESS_FLAGS, PORTAGE_RSYNC_EXTRA_OPTS

[Comment 1 Roy Bamford 2020-07-05 15:28:18 UTC]

Reproducable with dev-python/sphinx-3.1.1 on arm64

[Comment 2 Petr Cerny [:hrosik] 2020-07-19 21:29:16 UTC]

Reproduced with dev-python/sphinx-3.1.2 (amd64), the trouble just sits in a different source file:

    Sphinx-3.1.2/doc/internals/release-process.rst:99

[Comment 3 Mike DeSimone 2020-07-30 16:39:24 UTC]

Same problem here, breaking updates because sphinx-3.0.4 is marked stable.

[Comment 4 Erik 2020-08-13 08:00:54 UTC]

Version 3.1.2 fails with the same error but at doc/internals/release-process.rst:99.

[Comment 5 Dirk Sondermann 2020-08-30 11:04:07 UTC]

The problem is that doc/internals/release-process.rst contains an intersphinx reference

  (see the :ref:`Python docs on configuring warnings
  <python:describing-warning-filters>`) for more details

but intersphinx is disabled by the ebuild:

  python_prepare_all() {
      ...
      # disable internet access
      sed -i -e 's:^intersphinx_mapping:disabled_&:' \
          doc/conf.py || die
      ...
  }

As a workaround, I'm using the attached patch, which replaces the intersphinx reference by an external link.

(I have tested this patch with sphinx-3.1.2 and sphinx-3.2.1.)

[Comment 6 Dirk Sondermann 2020-08-30 11:08:16 UTC]

Created attachment 657496 [details, diff]
patch to replace intersphinx reference with an external link

[Comment 7 Erik 2020-09-19 21:35:42 UTC]

Version 3.2.1 fails with the same error but at doc/internals/release-process.rst:99.

[Comment 8 Anon Emuss 2020-11-14 05:23:55 UTC]

(In reply to Erik from comment #7)
> Version 3.2.1 fails with the same error but at
> doc/internals/release-process.rst:99.

Same here (dev-python/sphinx-3.2.1, amd64).  The patch in Comment 6 appears to fix the problem, although I removed the extra underscore after the link and before the closing parenthesis in that patch.  Was that a typo, or is it there for a reason?

[Comment 9 Dirk Sondermann 2020-11-15 17:29:15 UTC]

The underscore is there on purpose. In RST, the format of an external link is "`text <URL>`_" (see the file contributing.rst for examples of such links).

[Comment 10 Petr Cerny [:hrosik] 2020-11-16 23:19:39 UTC]

(In reply to Dirk Sondermann from comment #6)
> Created attachment 657496 [details, diff] [details, diff]
> patch to replace intersphinx reference with an external link

Confirming the patch works for sphinx-3.2.1.

Is there something that is preventing the patch from being included in the package?

[Comment 11 Anon Emuss 2020-11-17 03:57:39 UTC]

(In reply to Dirk Sondermann from comment #9)
> The underscore is there on purpose. In RST, the format of an external link
> is "`text <URL>`_" (see the file contributing.rst for examples of such
> links).

Thanks for explaining it to me.  Sorry I did not look around a little more before asking.

[Comment 12 Petr Cerny [:hrosik] 2020-11-30 22:18:54 UTC]

(In reply to Dirk Sondermann from comment #6)
> Created attachment 657496 [details, diff] [details, diff]
> patch to replace intersphinx reference with an external link

Confirming the patch works for sphinx-3.3.1.

Reiterating: is there something that is preventing the patch from being included in the package?

[Comment 13 Larry the Git Cow 2020-12-01 10:07:31 UTC]

The bug has been closed via the following commit(s):

https://gitweb.gentoo.org/repo/gentoo.git/commit/?id=9f0dc63ceeb5b7de8f50983e4e65b92812491458

commit 9f0dc63ceeb5b7de8f50983e4e65b92812491458
Author:     Sam James <[e-mail]>
AuthorDate: 2020-12-01 10:07:20 +0000
Commit:     Sam James <[e-mail]>
CommitDate: 2020-12-01 10:07:27 +0000

    dev-python/sphinx: fix USE=doc
    
    Thanks-to: Dirk Sondermann <[e-mail]>
    Closes: https://bugs.gentoo.org/728810
    Package-Manager: Portage-3.0.9, Repoman-3.0.2
    Signed-off-by: Sam James <[e-mail]>

 dev-python/sphinx/files/sphinx-3.3.1-doc-link.patch | 14 ++++++++++++++
 dev-python/sphinx/sphinx-3.3.1.ebuild               |  4 ++++
 2 files changed, 18 insertions(+)

[Comment 14 Larry the Git Cow 2020-12-01 10:12:01 UTC]

The bug has been referenced in the following commit(s):

https://gitweb.gentoo.org/repo/gentoo.git/commit/?id=e6de90e511e93aab2f6a8c0f774c4719e5a32ee9

commit e6de90e511e93aab2f6a8c0f774c4719e5a32ee9
Author:     Sam James <[e-mail]>
AuthorDate: 2020-12-01 10:11:54 +0000
Commit:     Sam James <[e-mail]>
CommitDate: 2020-12-01 10:11:54 +0000

    dev-python/sphinx: backport USE=doc fix to stable
    
    Bug: https://bugs.gentoo.org/728810
    Package-Manager: Portage-3.0.9, Repoman-3.0.2
    Signed-off-by: Sam James <[e-mail]>

 .../{sphinx-3.3.1-doc-link.patch => sphinx-3.2.1-doc-link.patch}      | 0
 dev-python/sphinx/sphinx-3.2.1.ebuild                                 | 4 ++++
 dev-python/sphinx/sphinx-3.3.1.ebuild                                 | 2 +-
 3 files changed, 5 insertions(+), 1 deletion(-)