From 0032f2768604da3999da6b794fb61c7208797763 Mon Sep 17 00:00:00 2001
From: patrick96
Date: Mon, 3 Apr 2023 02:28:41 +0200
Subject: [PATCH] doc: Use extlinks for linking to issues and PRs
---
doc/conf.py | 6 ++++++
doc/dev/release-workflow.rst | 3 +--
2 files changed, 7 insertions(+), 2 deletions(-)
diff --git a/doc/conf.py b/doc/conf.py
index f4b088e7..3f8b88bd 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -82,6 +82,7 @@ version_txt = get_version(Path(doc_path).absolute().parent)
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
+ "sphinx.ext.extlinks",
]
# Add any paths that contain templates here, relative to this directory.
@@ -115,6 +116,11 @@ highlight_language = 'none'
smartquotes = False
+extlinks = {
+ "issue": ("https://github.com/polybar/polybar/issues/%s", "#%s"),
+ "pull": ("https://github.com/polybar/polybar/pull/%s", "PR #%s"),
+}
+
# -- Options for HTML output -------------------------------------------------
diff --git a/doc/dev/release-workflow.rst b/doc/dev/release-workflow.rst
index f6ba8d52..3b66ff3b 100644
--- a/doc/dev/release-workflow.rst
+++ b/doc/dev/release-workflow.rst
@@ -216,8 +216,7 @@ After-Release Checklist
* Make sure all the new functionality is documented on the wiki
* Mark deprecated features appropriately (see `Deprecations`_)
* Remove all unreleased notes from the wiki (not for patch releases)
-* Inform packagers of new release in `#1971
- `_. Mention any dependency
+* Inform packagers of new release in :issue:`1971`. Mention any dependency
changes and any changes to the build workflow. Also mention any new files are
created by the installation.
* Create a PR that updates the AUR ``PKGBUILD`` file for the ``polybar-git``