Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 833618 - =dev-python/sphinx-4.4.0 USE=doc error: deploying.rst:162:unknown document: readthedocs:tutorial/index
Summary: =dev-python/sphinx-4.4.0 USE=doc error: deploying.rst:162:unknown document: r...
Status: UNCONFIRMED
Alias: None
Product: Gentoo Linux
Classification: Unclassified
Component: Current packages (show other bugs)
Hardware: All Linux
: Normal normal
Assignee: Python Gentoo Team
URL:
Whiteboard:
Keywords: PATCH
Depends on:
Blocks:
 
Reported: 2022-02-18 17:45 UTC by Red
Modified: 2023-04-02 07:05 UTC (History)
10 users (show)

See Also:
Package list:
Runtime testing required: ---

Attachments
Build log (sphinx-build.log,77.16 KB, text/x-log)
2022-02-18 17:45 UTC, Red 		Details
emerge --info (sphinx-emerge-info.txt,24.50 KB, text/plain)
2022-02-18 17:46 UTC, Red 		Details
no-intersphinx.patch (no-intersphinx.patch,918 bytes, patch)
2022-02-22 12:32 UTC, Dirk Sondermann 		Details | Diff
View All Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Red 2022-02-18 17:45:21 UTC 
=dev-python/sphinx-4.4.0 fails to build with USE=doc
It fails to emerge with the error:

Warning, treated as error:
/var/tmp/portage/dev-python/sphinx-4.4.0/work/Sphinx-4.4.0/doc/tutorial/deploying.rst:162:unknown document: readthedocs:tutorial/index

No problems building with USE=-doc

Build log and emerge --info attached.

Reproducible: Always
Comment 1 Red 2022-02-18 17:45:45 UTC 
Created attachment 765399 [details]
Build log
Comment 2 Red 2022-02-18 17:46:06 UTC 
Created attachment 765400 [details]
emerge --info
Comment 3 Dirk Sondermann 2022-02-22 12:30:01 UTC 
There are two problems:

1. The "unknown document: readthedocs:tutorial/index" error is caused by an  intersphinx reference which has to be replaced with an external link. This is completely analogous to Bug 823095 and Bug 728810.

2. When this problem is resolved (see the attached patch), the install phase failes with the following error:

FileNotFoundError: [Errno 2] No such file or directory: b'/var/tmp/portage/dev-python/sphinx-4.4.0/work/Sphinx-4.4.0-python3_9/sphinx/html/.'

This can be fixed by replacing

  HTML_DOCS=( "${BUILD_DIR}"/sphinx/html/. )

with

  HTML_DOCS=( "${S}"/build/sphinx/html/. )

in the the ebuild's python_compile_all() function.
Comment 4 Dirk Sondermann 2022-02-22 12:32:58 UTC 
Created attachment 765637 [details, diff]
no-intersphinx.patch

Patch to replace the intersphinx references with external links
Comment 5 Kenneth Lakin 2022-04-17 23:34:54 UTC 
I can confirm that the ebuild change in Comment #3 and patch in Comment #4 fix the issue for me.
Comment 6 Erik 2022-05-05 11:50:42 UTC 
Bug confirmed with version 4.4.0-r1.
Comment 7 Erik 2022-05-22 16:59:59 UTC 
Bug confirmed with version 4.5.0-r1.
Comment 8 Erik 2022-07-17 22:59:19 UTC 
FileNotFoundError: [Errno 2] No such file or directory: b'/var/tmp/portage/dev-python/sphinx-5.0.2/work/Sphinx-5.0.2-python3_10/sphinx/html/.'
Comment 9 Erik 2022-08-30 08:32:56 UTC 
FileNotFoundError: [Errno 2] No such file or directory: b'/var/tmp/portage/dev-python/sphinx-5.1.0/work/sphinx-5.1.0-python3_10/sphinx/html/.'
Comment 10 Erik 2022-08-31 12:11:19 UTC 
FileNotFoundError: [Errno 2] No such file or directory: b'/var/tmp/portage/dev-python/sphinx-5.1.1/work/sphinx-5.1.1-python3_10/sphinx/html/.'
Comment 11 Erik 2022-11-07 10:30:36 UTC 
FileNotFoundError: [Errno 2] No such file or directory: b'/var/tmp/portage/dev-python/sphinx-5.2.3/work/sphinx-5.2.3-python3_10/sphinx/html/.'
Comment 12 Erik 2023-04-02 07:05:48 UTC 
None of the broken versions (4.4.0, 5.1.0, 5.1.1, 5.2.3) exists any more so it seems like this bug is fixed.