{"author":null,"author_email":"Steven Loria ","bugtrack_url":null,"classifiers":["Framework :: Sphinx :: Extension","Intended Audience :: Developers","License :: OSI Approved :: MIT License","Programming Language :: Python :: 3","Programming Language :: Python :: 3.10","Programming Language :: Python :: 3.11","Programming Language :: Python :: 3.12","Programming Language :: Python :: 3.13","Programming Language :: Python :: 3.9","Topic :: Software Development :: Documentation"],"description":"=============\nsphinx-issues\n=============\n\n.. image:: https://badgen.net/pypi/v/sphinx-issues\n :target: https://pypi.org/project/sphinx-issues/\n :alt: PyPI badge\n\n.. image:: https://github.com/sloria/sphinx-issues/actions/workflows/build-release.yml/badge.svg\n :target: https://github.com/sloria/sphinx-issues/actions/workflows/build-release.yml\n :alt: Build status\n\nA Sphinx extension for linking to your project's issue tracker. Includes roles for linking to issues, pull requests, user profiles, with built-in support for GitHub (though this works with other services).\n\nExample\n*******\n\nFor an example usage, check out `marshmallow's changelog `_, which makes use of the roles in this library.\n\nInstallation and Configuration\n******************************\n\n.. code-block:: console\n\n pip install sphinx-issues\n\n\nAdd ``sphinx_issues`` to ``extensions`` in your ``conf.py``.\n\nThe extension has default values for GitHub projects.\nAdd the ``issues_github_path`` config variable and you are good\nto go:\n\n.. code-block:: python\n\n # docs/conf.py\n\n # ...\n extensions = [\n # ...\n \"sphinx_issues\"\n ]\n\n # Path to GitHub repo {group}/{project} (note that `group` is the GitHub user or organization)\n issues_github_path = \"sloria/marshmallow\"\n\n # which is the equivalent to:\n issues_uri = \"https://github.com/{group}/{project}/issues/{issue}\"\n issues_prefix = \"#\"\n issues_pr_uri = \"https://github.com/{group}/{project}/pull/{pr}\"\n issues_pr_prefix = \"#\"\n issues_commit_uri = \"https://github.com/{group}/{project}/commit/{commit}\"\n issues_commit_prefix = \"@\"\n issues_user_uri = \"https://github.com/{user}\"\n issues_user_prefix = \"@\"\n\nYou can also use this extension with other issue trackers. Here is how you could configure it for a hosted GitLab instance:\n\n.. code-block:: python\n\n # docs/conf.py\n\n # ...\n extensions = [\n # ...\n \"sphinx_issues\"\n ]\n\n # Default repo {group}/{project} of gitlab project\n issues_default_group_project = \"myteam/super_great_project\"\n issues_uri = \"https://gitlab.company.com/{group}/{project}/-/issues/{issue}\"\n issues_prefix = \"#\"\n issues_pr_uri = \"https://gitlab.company.com/{group}/{project}/-/merge_requests/{pr}\"\n issues_pr_prefix = \"!\"\n issues_commit_uri = \"https://gitlab.company.com/{group}/{project}/-/commit/{commit}\"\n issues_commit_prefix = \"@\"\n issues_user_uri = \"https://gitlab.company.com/{user}\"\n issues_user_prefix = \"@\"\n\n\nUsage inside the documentation\n******************************\n\nUse the ``:issue:`` and ``:pr:`` roles in your docs like so:\n\n.. code-block:: rst\n\n See issue :issue:`42`\n\n See issues :issue:`12,13`\n\n See :issue:`sloria/konch#45`.\n\n See PR :pr:`58`\n\n\nThe ``:user:`` role links to user profiles (GitHub by default, but can be configured via the ``issues_user_uri`` config variable).\n\nThe ``:commit:`` role links to commits.\n\n.. code-block:: rst\n\n Fixed in :commit:`6bb9124d5e9dbb2f7b52864c3d8af7feb1b69403`.\n\n.. code-block:: rst\n\n Thanks to :user:`bitprophet` for the idea!\n\nYou can also change the text of the hyperlink:\n\n.. code-block:: rst\n\n This change is due to :user:`Andreas Mueller `.\n\nThe syntax ``:role:`My custom title ``` works for all roles of this extension.\n\n.. code-block:: rst\n\n Fix bad bug :issue:`123, 199 (Duplicate) <123>`\n\nThe ``:pypi:`` role links to project pages on `PyPI `_.\n\n.. code-block:: rst\n\n :pypi:`sphinx-issues` - A Sphinx extension for linking to your project's issue tracker.\n\nImportant note about :cwe: and :cve: roles\n******************************************\n\nThe ``:cwe:`` and ``:cve:`` are included within `newer versions of Sphinx `_.\nIf you use these roles and are using Sphinx<8.1, you will need to\ninstall sphinx-issues<5.\n\nCredits\n*******\n\nCredit goes to Jeff Forcier for his work on the `releases `_ extension, which is a full-featured solution for generating changelogs. I just needed a quick way to reference GitHub issues in my docs, so I yoinked the bits that I needed.\n\nLicense\n*******\n\nMIT licensed. See the bundled `LICENSE `_ file for more details.\n\n\nChangelog\n*********\n\n5.0.1 (2025-04-10)\n------------------\n\n- Properly handle user and org names with symbols in them (`#174 `_).\n Thanks @ilan-gold for reporting and @flying-sheep for the PR.\n\n5.0.0 (2024-10-11)\n------------------\n\n- Remove `:cwe:` and `:cve:` roles, as these are officially included in Sphinx>=8.1.0.\n- Support Python 3.9-3.13. Python 3.8 is no longer supported.\n\n4.1.0 (2024-04-14)\n------------------\n\n- Add `:pypi:` role for linking to PyPI projects (`#144 `_).\n Thanks @shenxianpeng for the suggestion and PR.\n\n4.0.0 (2024-01-19)\n------------------\n\n- Default to linking GH Sponsors for the :user: role (`#129 `_).\n Thanks @webknjaz for the suggestion.\n- Support Python 3.8-3.12. Older versions are no longer supported.\n- *Backwards-incompatible*: Remove ``__version__``, ``__author__``, and ``__license__`` attributes.\n Use ``importlib.metadata`` to read this metadata instead.\n\n3.0.1 (2022-01-11)\n------------------\n\n- Fix regression from 3.0.0: `exception: 'in ' requires string as left operand, not type`.\n\n3.0.0 (2022-01-10)\n------------------\n\n- The `:commit:` role now outputs with an `@` prefix.\n- Add configuration options for changing prefixes.\n- Allow `{group}` to be specified within `issues_uri`, `issues_pr_uri`, `issues_commit_uri`, and \n\n2.0.0 (2022-01-01)\n------------------\n\n- Drop support for Python 2.7 and 3.5.\n- Test against Python 3.8 to 3.10.\n- Add ``:cwe:`` role for linking to CVEs on https://cwe.mitre.org.\n Thanks @hugovk for the PR.\n- Add support for custom urls and separators `Issue #93 `_\n- Allow custom titles for all roles `Issue #116 `_\n- Added setting `issues_default_group_project` as future replacement of `issues_github_path`, to reflect the now to universal nature of the extension\n\n1.2.0 (2018-12-26)\n------------------\n\n- Add ``:commit:`` role for linking to commits.\n- Add support for linking to external repos.\n- Test against Python 3.7.\n\n1.1.0 (2018-09-18)\n------------------\n\n- Add ``:cve:`` role for linking to CVEs on https://cve.mitre.org.\n\n1.0.0 (2018-07-14)\n------------------\n\n- Add ``:pr:`` role. Thanks @jnotham for the suggestion.\n- Drop support for Python 3.4.\n\n0.4.0 (2017-11-25)\n------------------\n\n- Raise ``ValueError`` if neither ``issues_uri`` nor ``issues_github_path`` is set. Thanks @jnothman for the PR.\n- Drop support for Python 2.6 and 3.3.\n\n0.3.1 (2017-01-16)\n------------------\n\n- ``setup`` returns metadata, preventing warnings about parallel reads and writes. Thanks @jfinkels for reporting.\n\n0.3.0 (2016-10-20)\n------------------\n\n- Support anchor text for ``:user:`` role. Thanks @jnothman for the suggestion and thanks @amueller for the PR.\n\n0.2.0 (2014-12-22)\n------------------\n\n- Add ``:user:`` role for linking to GitHub user profiles.\n\n0.1.0 (2014-12-21)\n------------------\n\n- Initial release.\n\n","description_content_type":"text/x-rst","docs_url":null,"download_url":null,"downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":null,"home_page":null,"keywords":"sphinx, issues, github","license":null,"license_expression":null,"license_files":["LICENSE"],"maintainer":null,"maintainer_email":null,"name":"sphinx-issues","package_url":"https://pypi.org/project/sphinx-issues/","platform":null,"project_url":"https://pypi.org/project/sphinx-issues/","project_urls":{"Issues":"https://github.com/sloria/sphinx-issues/issues","Source":"https://github.com/sloria/sphinx-issues"},"provides_extra":["dev","tests"],"release_url":"https://pypi.org/project/sphinx-issues/5.0.1/","requires_dist":["sphinx","sphinx-issues[tests]; extra == \"dev\"","tox; extra == \"dev\"","pre-commit<5.0,>=3.6; extra == \"dev\"","pytest; extra == \"tests\""],"requires_python":">=3.9","summary":"A Sphinx extension for linking to your project's issue tracker","version":"5.0.1","yanked":false,"yanked_reason":null}

Dependencies of sphinx-issues (5).
Dependency	Optional
sphinx	false
pre-commit	true
pytest	true
sphinx-issues	true
tox	true

Package search

sphinx-issues

project_urls

Dependencies

All package metadata

Releases