{"library":"sphinx-issues","title":"Sphinx Issues","type":"library","description":"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.","language":"python","status":"active","last_verified":"Thu Apr 16","install":{"commands":["pip install sphinx-issues"],"cli":null},"imports":["extensions = ['sphinx_issues']"],"auth":{"required":false,"env_vars":[]},"links":{"homepage":null,"github":"https://github.com/sloria/sphinx-issues","docs":null,"changelog":null,"pypi":"https://pypi.org/project/sphinx-issues/","npm":null,"openapi_spec":null,"status_page":null,"smithery":null},"quickstart":{"code":"# conf.py\n\nimport os\nimport sys\nsys.path.insert(0, os.path.abspath('.'))\n\nproject = 'My Project'\ncopyright = '2026, Your Name'\nauthor = 'Your Name'\nrelease = '0.1'\n\nextensions = [\n    'sphinx_issues'\n]\n\n# Required for GitHub integration\n# Replace 'sloria/marshmallow' with your project's GitHub path (user/repo or org/repo)\nissues_github_path = 'sloria/marshmallow'\n\n# Example usage in an .rst file:\n# See issue :issue:`42`\n# See PR :pr:`58`\n# Thanks to :user:`bitprophet`\n# Fixed in :commit:`6bb9124d5e9dbb2f7b52864c3d8af7feb1b69403`\n","lang":"python","description":"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.","tag":null,"tag_description":null,"last_tested":null,"results":[]},"compatibility":null}