1851235 - makedocs.pl fails on modern versions of Sphinx (7.2.5) - TypeError: not all arguments converted during string formatting

Status: RESOLVED FIXED

(Bugzilla :: Documentation, defect)

Description

[Dave Miller [:justdave]]

❯ perl docs/makedocs.pl
Creating API documentation...

Creating HTML documentation ...
sphinx-build -b html -d ./doctrees   rst ./html
Running Sphinx v7.2.5
building [mo]: targets for 0 po files that are out of date
writing output...
building [html]: targets for 78 source files that are out of date
updating environment: [new config] 78 added, 0 changed, 0 removed
/Users/dave/Source/Bugzilla/bugzilla/docs/en/rst/administering/extensions.rst:14: WARNING: toctree glob pattern '../extensions/*/index-admin' didn't match any documents

Exception occurred:
  File "/usr/local/lib/python3.11/site-packages/sphinx/ext/extlinks.py", line 108, in role
    title = caption % part
            ~~~~~~~~^~~~~~
TypeError: not all arguments converted during string formatting
The full traceback has been saved in /var/folders/qn/lhjhrnjr8xl2bk001s6gv8jr0000gq/T/sphinx-err-v9rhqmwr.log, if you want to report the issue to the developers.
Please also report this if it was a user error, so that a better error message can be provided next time.
A bug report can be filed in the tracker at <https://github.com/sphinx-doc/sphinx/issues>. Thanks!
make: *** [html] Error 2

Comment 1

[Dave Miller [:justdave]]

Attachment: patch for 5.2

LCP provided this patch on Discord.

It works on Sphinx 7.2.5, and the behavior on Sphinx 4.3.2 is unchanged.

Comment 2

[Dave Miller [:justdave]]

Attachment: GitHub Pull Request for 5.2

Comment 3

[Dave Miller [:justdave]]

The PR for 5.2 has landed.
https://github.com/bugzilla/bugzilla/commit/3dbca9bf8e2e6541203f043244639e6557846506

We should probably port this to harmony before closing the bug.

Comment 4

[Dave Miller [:justdave]]

Attachment: GitHub Pull Request for harmony by Emma

Comment 5

[Dave Miller [:justdave]]

Comment on attachment 9401584 [details] [review]
GitHub Pull Request for harmony by Emma

https://github.com/bugzilla/harmony/commit/111cc0c8be238e6727c9489de2ad02aeff0b1cdf