aio-libs / propcache / 35569495579

93%

push

github

📝 Replace most `extlinks` w/ `sphinx-issues` in Sphinx config

PR #307 closes #306

The `sphinx-issues` extension provides the `:issue:`, `:pr:`, `:commit:`
and `:user:` roles that were previously hand-rolled via
`sphinx.ext.extlinks`, and is more flexible about how their content is
processed -- in the docs, it additionally understands cross-repository
references like `org/repo#123`.

Its default URL templates already match the ones the removed `extlinks`
entries used, including `:user:` pointing at GitHub Sponsors, so only
`issues_github_path` needs configuring. The link captions do change
slightly -- `:pr:` renders as `#N` rather than `PR #N` and `:commit:` as
an `@`-prefixed abbreviated SHA -- since the extension only accepts `#`,
`@` or `!` as a caption prefix.

`extlinks` is kept for the `:gh:` role, which `sphinx-issues` does not
provide.

Ported from ansible/pylibssh@55f124d (PR 818).

31 of 62 branches covered (50.0%)

Branch coverage included in aggregate %.

984 of 1026 relevant lines covered (95.91%)

0.96 hits per line