[GUACAMOLE-1834] Manual build fails as of Sphinx 6.x

• Type: Bug
• Status: Closed
• Priority: Blocker
• Resolution: Fixed
• Fix Version/s: 1.5.3
• Component/s: Documentation
• Assignee: Mike Jumper
• Reporter: Mike Jumper
• Created: 14/Jul/23 17:43
• Updated: 16/Jul/23 20:37
• Resolved: 16/Jul/23 20:37

Description

The "extlinks" plugin for Sphinx warns that it will be introducing new requirements for its configuration as of Sphinx 6.0:

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

This has now occurred, and the build of the 1.5.3 manual fails with the following error:

...
reading sources... [ 12%] configuring-guacamole                                                                         
Exception occurred:
  File "/home/mjumper/.local/lib/python3.11/site-packages/sphinx/ext/extlinks.py", line 103, in role
    title = caption % part
            ~~~~~~~~^~~~~~
TypeError: not all arguments converted during string formatting
The full traceback has been saved in /tmp/sphinx-err-husuryy_.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: *** [Makefile:47: build/html/index.html] Error 2

Issue Links

• is duplicated by: GUACAMOLE-1835 Guacamole-manual CI (docker) build is broken