From 89ca0255f132d9dd542a92c54f949d1594a69a22 Mon Sep 17 00:00:00 2001 From: patrick96 Date: Tue, 18 Apr 2023 15:38:35 +0200 Subject: [PATCH] doc: Fix extlinks %s substitution in caption Substitutions in the caption are only supported in version 4 of sphinx. However, RTD uses sphinx 1.8.6 Just letting it append the value seems to work in both 1.8.6 and newer versions. --- doc/conf.py | 4 ++-- doc/user/modules/tray.rst | 3 ++- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/doc/conf.py b/doc/conf.py index ebe9b43b..255061a9 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -118,8 +118,8 @@ smartquotes = False # Quickly link to issues or PRs using :issue:`...` or :pull:`...` extlinks = { - "issue": ("https://github.com/polybar/polybar/issues/%s", "#%s"), - "pull": ("https://github.com/polybar/polybar/pull/%s", "PR #%s"), + "issue": ("https://github.com/polybar/polybar/issues/%s", "#"), + "pull": ("https://github.com/polybar/polybar/pull/%s", "PR #"), } extlinks_detect_hardcoded_links = True diff --git a/doc/user/modules/tray.rst b/doc/user/modules/tray.rst index 5ec4e5f3..9a6314f7 100644 --- a/doc/user/modules/tray.rst +++ b/doc/user/modules/tray.rst @@ -69,7 +69,8 @@ Settings .. note:: This only affects the color of the individual icons and not the space in between, changing this setting to anything else than the bar background - will likely not look good. + will likely not look good unless the background color is also changed for + the rest of the tray module (e.g. with ``format-background``). :type: |type-color| :default: ``${root.background}``