Skip to content

Instantly share code, notes, and snippets.

Last active August 28, 2022 16:43
What would you like to do?
sphinxcontrib-issuetracker working as of sphinx 5.1.1, includes strict mypy typings (sphinx-doc with github style linking)

Autolink plain text issues in Sphinx

Smart linking of text issues w/ sphinx-doc, "GitHub" / "GitLab" / etc. style. No roles / without roles being required.

Original package / credit

StackOverflow post


Projects like require using docutils roles, e.g.

plain-old docutils / reStructuredText:




So it won't render issues properly when viewing in GitHub / Gitlab / etc previews.

We need something that'll work in standard GitHub / GitLab / etc viewers

mypy users


You can use mypy --strict (tested as of mypy .971, released July 19, 2022)

import sys
from pathlib import Path
cwd = Path(__file__).parent
project_root = cwd.parent
sys.path.insert(0, str(project_root))
sys.path.insert(0, str(cwd / "_ext"))
extensions = [
# issuetracker
issuetracker = "github"
issuetracker_project = "cihai/unihan-etl" # e.g. for
Copy link

tony commented Aug 21, 2022

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment