Registry / http-networking / sphinx-issues

sphinx-issues

library6.0.0pypypiunverified

Sphinx Issues is a Sphinx extension designed to facilitate linking to a project's issue tracker directly within reStructuredText documentation. It provides roles for creating links to issues, pull requests, user profiles, and commits, with built-in support for GitHub and flexible configuration for other platforms like GitLab. The current version is 6.0.0, released on March 13, 2026, and it maintains an active development and release cadence.

http-networking

pip install sphinx-issues

github ↗package ↗

INSTALL

IMPORT

SIG · SPHINX-ISSUES

sphinx-issues

http-networkingpythonv6.0.0

Install

5.2s avg

Import

—

Disk

94MB

Pass rate

10/ 10

Env Coverage10 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v6.0.0 · pip install

no network on importno background threads

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

py 3.10–3.910 runs

installs and imports cleanly · install 0.0s · import 0.000s · 92.1MB

glibc

py 3.10–3.910 runs

installs and imports cleanly · install 5.2s · import 0.000s · 93MB

94MB installed

● package 94MB

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

sphinx_issues

✓ extensions = ['sphinx_issues']

sphinx-issues is enabled as a Sphinx extension by adding its module name to the 'extensions' list in your project's conf.py file.

To quickly integrate `sphinx-issues`, first install it via pip. Then, add `'sphinx_issues'` to the `extensions` list in your Sphinx project's `conf.py`. For GitHub projects, configure `issues_github_path` to specify your repository. This enables the `:issue:`, `:pr:`, `:commit:`, and `:user:` roles in your reStructuredText files.

# conf.py import os import sys sys.path.insert(0, os.path.abspath('.')) project = 'My Project' copyright = '2026, Your Name' author = 'Your Name' release = '0.1' extensions = [ 'sphinx_issues' ] # Required for GitHub integration # Replace 'sloria/marshmallow' with your project's GitHub path (user/repo or org/repo) issues_github_path = 'sloria/marshmallow' # Example usage in an .rst file: # See issue :issue:`42` # See PR :pr:`58` # Thanks to :user:`bitprophet` # Fixed in :commit:`6bb9124d5e9dbb2f7b52864c3d8af7feb1b69403`

Debug

Known issues

breakingVersion 6.0.0 removes implicit extraction of the group/project from GitHub URLs when `issues_uri` is set. You must now explicitly define `issues_github_path` or `issues_default_group_project` for GitHub projects, or fully specify `issues_uri` and related paths for custom trackers.

fix

In `conf.py`, set `issues_github_path = 'your_github_user_or_org/your_repo_name'` for GitHub, or explicitly define `issues_uri`, `issues_pr_uri`, `issues_commit_uri`, and `issues_user_uri` for other services.

affects: >=6.0.0

breakingAs of version 5.0.0, the `:cwe:` and `:cve:` roles were removed from `sphinx-issues` because these roles are now officially included in Sphinx >= 8.1. If you are using Sphinx < 8.1 and still require these roles, you must pin `sphinx-issues` to a version less than 5 (`sphinx-issues<5`).

fix

Upgrade Sphinx to version 8.1 or higher. If upgrading Sphinx is not an option, downgrade `sphinx-issues` to `<5.0.0`.

affects: >=5.0.0

gotchasphinx-issues v6.0.0 officially supports Python 3.10-3.14. Python 3.9 and older versions are no longer supported. Ensure your project's Python environment meets this requirement to avoid installation or runtime issues.

fix

Upgrade your Python environment to 3.10 or newer. If you must use Python 3.9 or older, you will need to use an older version of `sphinx-issues` (e.g., `<6.0.0`).

affects: >=6.0.0

gotcha`sphinx-issues` version 6.0.0 requires Sphinx version 8.1.0 or newer. Installing `sphinx-issues` v6.0.0 with an older Sphinx version may lead to unexpected behavior or build errors.

fix

Ensure your Sphinx installation is `sphinx>=8.1.0`. Update Sphinx using `pip install -U sphinx` or specify the version in your `requirements.txt`.

affects: >=6.0.0

Upgrade

Version history

6.0.0latest on PyPI · released Mar 13, 2026

Audit

Dependencies

SphinxrequiredCore documentation generator framework. sphinx-issues v6.0.0 requires Sphinx >= 8.1.0.

PythonrequiredRuntime environment. Requires Python >=3.10 (3.10-3.14 supported for v6.0.0).

Agent activity

7 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/sloria/sphinx-issues ↗

packagehttps://pypi.org/project/sphinx-issues/ ↗