sphinx-issues
A Sphinx extension for linking to your project's issue tracker
Decision gist · record as of 2026-08-14
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.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Sphinx 8.1.0 or later and Python 3.10 or later.
- 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 · maintenance · safety
permissive license (permissive) — Licensed under MIT (permissive), allowing use in commercial and private projects with minimal restrictions.
last release 2026-03-13 (154 days) · last repo commit 2026-08-08 · 60 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 229,396 downloads/mo, #9,133 on PyPI
Alternatives
Verify before relying
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`- 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.
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 on it.
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
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.
Requires Sphinx 8.1.0 or later and Python 3.10 or later.
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`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
| License | permissive license permissive |
| Python support | Supports the current Python release >=3.10 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 1 packagesphinx |
| Maintenance | Actively maintained 154 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 229,396 / month, #9,133 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Framework :: Sphinx :: ExtensionIntended Audience :: DevelopersLicense :: OSI Approved :: MIT LicenseProgramming Language :: Python :: 3Programming Language :: Python :: 3.10Programming Language :: Python :: 3.11Programming Language :: Python :: 3.12Programming Language :: Python :: 3.13Programming Language :: Python :: 3.14Topic :: Software Development :: Documentation |
Evidence: sphinx_issues-6.0.0-py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “sphinx issue tracker links”
- sphinx-issuesA Sphinx extension that adds roles for linking to issues, pull…
- spec-kitty-trackerProvides a unified abstraction layer for connecting to multiple issue…
- git-me-the-urlConverts git repository references (file paths, commits, branches)…
Give your agent the search over MCP, or paste the wish link into any chat.
More Documentation packages
Docutils converts plaintext documentation in reStructuredText format into multiple output formats including HTML, XML, and LaTeX using a modular processing system.
Converts Markdown text to HTML using a Python implementation of John Gruber's Markdown specification, with support for extensions.
Install it if you need to parse Markdown in Python.
Sphinx generates professional documentation from reStructuredText source files, producing HTML, PDF, EPUB, and other formats with automatic cross-references, code highlighting, and hierarchical navigation.
Griffe extracts the complete structure and signatures of Python programs to generate API documentation or detect breaking changes in your project's public API.
Install it if you need to programmatically inspect Python code structure, generate API docs, or enforce API stability in CI.
Alabaster is a clean, responsive Sphinx theme for documentation that requires Python 3.10 or newer and Sphinx 6.2 or newer.
Material for MkDocs is a professional theme and extension for MkDocs that transforms Markdown documentation into a responsive, searchable static site with minimal configuration.
Install it if you need to publish Markdown-based documentation as a professional static site without writing custom HTML or CSS.
See also sphinx-needs · sphinxcontrib-django · sphinx-substitution-extensions · sphinx-last-updated-by-git · sphinx-tabs · intersphinx-registry · sphinx-notfound-page · sphinx-codeautolink · sphinx-panels · sphinx-favicon