sphinx-issues

What it is and what it does

sphinx-issues is a Sphinx extension that lets you embed clickable references to issues, pull requests, commits, and user profiles directly in your documentation using simple reStructuredText roles. Instead of writing out full URLs, you write `:issue:`42`` or `:pr:`58`` and the extension automatically generates links to your configured issue tracker—GitHub by default, but customizable for GitLab, Jira, or any other service.

The extension handles the boilerplate of URL construction and supports custom link text, multiple issue references in one role, and cross-repository links. It's designed to keep changelogs and release notes readable while maintaining live links to your project's actual issues and pull requests. Configuration is minimal: set your GitHub path or custom tracker URLs in your Sphinx conf.py, and the roles work immediately in your documentation.

Use it for:

• Link to GitHub issues and PRs in your project's changelog without writing full URLs.
• Reference commits in release notes with automatic links to the commit on GitHub.
• Create user profile links in contributor acknowledgments or documentation.
• Configure the extension for a self-hosted GitLab or other issue tracker instead of GitHub.
• Link to PyPI project pages from your documentation using the :pypi: role.
• Add custom link text to issue references for more readable documentation prose.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

A Sphinx extension that adds roles for linking to issues, pull requests, commits, and user profiles in your documentation, with built-in support for GitHub and configurable support for other issue trackers.

Yes. This is a lightweight, actively maintained extension with no security vulnerabilities, low install friction, and a clear single purpose. If your Sphinx documentation references issues or pull requests, it eliminates manual URL management and keeps links maintainable. The permissive MIT license poses no restrictions. Install it if you maintain a project with a public issue tracker and want to reference issues in your docs.

Install

sphinx-issues on PyPI

pip install sphinx-issues

uv add sphinx-issues

poetry add sphinx-issues

Installing sphinx-issues

Before you install

Low friction install with a single runtime dependency on sphinx. Actively maintained as of 2026-03-13, with recent updates supporting Python 3.10-3.14 and a minimum Sphinx version of 8.1.0.

License in practice

Licensed under MIT (permissive), allowing use in commercial and private projects with minimal restrictions.

Quickstart

pip install sphinx-issues

# In docs/conf.py
extensions = ["sphinx_issues"]
issues_github_path = "owner/repo"

# In your .rst files
See issue :issue:`42` or PR :pr:`58`

Requires Sphinx 8.1.0 or later and Python 3.10 or later.

Verify before relying

• Whether the extension's role syntax works with all reStructuredText editors and preview tools.
• Performance impact when documentation contains many linked issues or pull requests.
• Compatibility with Sphinx themes beyond the standard ones.

Package facts

Evidence: sphinx_issues-6.0.0-py3-none-any.whl

Keywords: sphinx, issues, github

Tags

More Documentation packages