doc: Use extlinks for linking to issues and PRs

This commit is contained in:
patrick96 2023-04-03 02:28:41 +02:00 committed by Patrick Ziegler
parent 234e606b41
commit 0032f27686
2 changed files with 7 additions and 2 deletions

View File

@ -82,6 +82,7 @@ version_txt = get_version(Path(doc_path).absolute().parent)
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones. # ones.
extensions = [ extensions = [
"sphinx.ext.extlinks",
] ]
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
@ -115,6 +116,11 @@ highlight_language = 'none'
smartquotes = False 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 ------------------------------------------------- # -- Options for HTML output -------------------------------------------------

View File

@ -216,8 +216,7 @@ After-Release Checklist
* Make sure all the new functionality is documented on the wiki * Make sure all the new functionality is documented on the wiki
* Mark deprecated features appropriately (see `Deprecations`_) * Mark deprecated features appropriately (see `Deprecations`_)
* Remove all unreleased notes from the wiki (not for patch releases) * Remove all unreleased notes from the wiki (not for patch releases)
* Inform packagers of new release in `#1971 * Inform packagers of new release in :issue:`1971`. Mention any dependency
<https://github.com/polybar/polybar/issues/1971>`_. Mention any dependency
changes and any changes to the build workflow. Also mention any new files are changes and any changes to the build workflow. Also mention any new files are
created by the installation. created by the installation.
* Create a PR that updates the AUR ``PKGBUILD`` file for the ``polybar-git`` * Create a PR that updates the AUR ``PKGBUILD`` file for the ``polybar-git``