We currently need to replace the include:: directives in the cpython documentation source files to fix an issue that sphinx/docutils have with relative source files after changing the app.srcdir in our conf.py.

Instead of doing this, let's define the app.srcdir property as an absolute path. This removes the issue altogether, yielding a correct build without the need to modify the documentation source files.

This change seems to have the nice side effect that successive builds are not incremental rather than starting from scratch.

Edit: additionally, we now define sphinx'sapp.srcdir as a Path, which seems to be a requirement at least in 8.1.3, which is what we''l use for building the 3.13 docs. Seesphinx-doc/sphinx#13018.

Closes#1844

rtobar added2 commits

November 18, 2024 12:54

Remove include:: replacements hack

6191d45

We currently need to replace the include:: directives in the cpythondocumentation source files to fix an issue that sphinx/docutils havewith relative source files after changing the app.srcdir in our conf.py.Instead of doing this, let's define the app.srcdir property as anabsolute path. This removes the issue altogether, yielding a correctbuild without the need to modify the documentation source files.This change seems to have the nice side effect that successive buildsare not incremental rather than starting from scratch.Signed-off-by: Rodrigo Tobar <rtobar@icrar.org>

Define srcdir as a Path

5b571c6

This doesn't break anything, and seems to be required at least in Sphinx8.1.3, most probably some earlier versions too (we're in 7.2.6).Signed-off-by: Rodrigo Tobar <rtobar@icrar.org>

rtobar mentioned this pull request

Nov 18, 2024

Unclear error message: TypeError: unsupported operand type(s) for /: 'str' and 'str'sphinx-doc/sphinx#13018

Closed