{"id":15645988,"url":"https://github.com/sloria/sphinx-issues","last_synced_at":"2025-04-09T21:18:11.233Z","repository":{"id":24894458,"uuid":"28310771","full_name":"sloria/sphinx-issues","owner":"sloria","description":"A Sphinx extension for linking to your project's issue tracker","archived":false,"fork":false,"pushed_at":"2025-04-07T20:19:58.000Z","size":226,"stargazers_count":55,"open_issues_count":3,"forks_count":13,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-04-09T21:18:06.439Z","etag":null,"topics":["changelog","documentation","github","issues","prs","python","sphinx","sphinx-extension"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sloria.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2014-12-21T19:43:04.000Z","updated_at":"2025-03-04T16:32:11.000Z","dependencies_parsed_at":"2024-04-02T18:25:23.998Z","dependency_job_id":"45675ebf-580a-4f90-87a2-a8748242d9fd","html_url":"https://github.com/sloria/sphinx-issues","commit_stats":{"total_commits":165,"total_committers":10,"mean_commits":16.5,"dds":0.5393939393939393,"last_synced_commit":"08c376fc2f994038b653720c431abeadf6cc628e"},"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sloria%2Fsphinx-issues","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sloria%2Fsphinx-issues/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sloria%2Fsphinx-issues/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sloria%2Fsphinx-issues/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sloria","download_url":"https://codeload.github.com/sloria/sphinx-issues/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248111973,"owners_count":21049578,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["changelog","documentation","github","issues","prs","python","sphinx","sphinx-extension"],"created_at":"2024-10-03T12:10:52.891Z","updated_at":"2025-04-09T21:18:11.203Z","avatar_url":"https://github.com/sloria.png","language":"Python","readme":"=============\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 \u003chttp://marshmallow.readthedocs.org/en/latest/changelog.html\u003e`_, 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 \u003camueller\u003e`.\n\nThe syntax ``:role:`My custom title \u003ctarget\u003e``` works for all roles of this extension.\n\n.. code-block:: rst\n\n    Fix bad bug :issue:`123, 199 (Duplicate) \u003c123\u003e`\n\nThe ``:pypi:`` role links to project pages on `PyPI \u003chttps://pypi.org\u003e`_.\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 \u003chttps://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-cve\u003e`_.\nIf you use these roles and are using Sphinx\u003c8.1, you will need to\ninstall sphinx-issues\u003c5.\n\nCredits\n*******\n\nCredit goes to Jeff Forcier for his work on the `releases \u003chttps://github.com/bitprophet/releases\u003e`_ 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 \u003chttps://github.com/sloria/sphinx-issues/blob/master/LICENSE\u003e`_ file for more details.\n\n\nChangelog\n*********\n\n5.0.0 (2024-10-11)\n------------------\n\n- Remove `:cwe:` and `:cve:` roles, as these are officially included in Sphinx\u003e=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 \u003chttps://github.com/sloria/sphinx-issues/issues/144\u003e`_).\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 \u003chttps://github.com/sloria/sphinx-issues/issues/129\u003e`_).\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 \u003cstring\u003e' 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 \u003chttps://github.com/sloria/sphinx-issues/issues/93\u003e`_\n- Allow custom titles for all roles `Issue #116 \u003chttps://github.com/sloria/sphinx-issues/issues/116\u003e`_\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","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsloria%2Fsphinx-issues","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsloria%2Fsphinx-issues","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsloria%2Fsphinx-issues/lists"}