From 44b5f878847649e65f88dda9443b522f5df5494b Mon Sep 17 00:00:00 2001 From: patrick96 Date: Mon, 3 Apr 2023 14:42:48 +0200 Subject: [PATCH] doc: Use issue directive to link to issue --- doc/conf.py | 3 +++ doc/dev/packaging.rst | 5 ++--- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/doc/conf.py b/doc/conf.py index 3a2bdf67..d1972fd4 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -116,11 +116,14 @@ highlight_language = 'none' 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"), } +extlinks_detect_hardcoded_links = True + # -- Options for HTML output ------------------------------------------------- diff --git a/doc/dev/packaging.rst b/doc/dev/packaging.rst index c0436b11..0385ca7b 100644 --- a/doc/dev/packaging.rst +++ b/doc/dev/packaging.rst @@ -78,9 +78,8 @@ Instead of ``sudo make install``, you will most likely want to use Finishing Up ------------ -Finally, subscribe to our `GitHub thread for package maintainers -`_ to get notified about new -releases and changes to how polybar is built. +Finally, subscribe to our :issue:`GitHub thread for package maintainers <1971>` +to get notified about new releases and changes to how polybar is built. If you want to, you can also open a PR to add your package to the `Getting Started `_ section of our README.