{ "info": { "author": "Steven Loria", "author_email": "sloria1@gmail.com", "bugtrack_url": null, "classifiers": [ "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Topic :: Software Development :: Documentation" ], "description": "=============\nsphinx-issues\n=============\n\n.. image:: https://travis-ci.org/sloria/sphinx-issues.svg?branch=master\n :target: https://travis-ci.org/sloria/sphinx-issues\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``. If your project is on GitHub, add the ``issues_github_path`` config variable. Otherwise, use ``issues_uri`` and ``issues_pr_uri``.\n\n.. code-block:: python\n\n # docs/conf.py\n\n # ...\n extensions = [\n # ...\n \"sphinx_issues\"\n ]\n\n # Github repo\n issues_github_path = \"sloria/marshmallow\"\n\n # equivalent to\n issues_uri = \"https://github.com/sloria/marshmallow/issues/{issue}\"\n issues_pr_uri = \"https://github.com/sloria/marshmallow/pull/{pr}\"\n issues_commit_uri = \"https://github.com/sloria/marshmallow/commit/{commit}\"\n\nUsage\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\nUse the ``:user:`` role in your docs to link to user profiles (Github by default, but can be configured via the ``issues_user_uri`` config variable).\n\n.. code-block:: rst\n\n Thanks to :user:`bitprophet` for the idea!\n\nYou can also use explicit names if you want to use a different name than the github user name:\n\n.. code-block:: rst\n\n This change is due to :user:`Andreas Mueller `.\n\n\nUse the ``:commit:`` role to link to commits.\n\n.. code-block:: rst\n\n Fixed in :commit:`6bb9124d5e9dbb2f7b52864c3d8af7feb1b69403`.\n\nUse the ``:cve:`` role to link to CVEs on https://cve.mitre.org.\n\n.. code-block:: rst\n\n :cve:`CVE-2018-17175` - Addresses possible vulnerability when...\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\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\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/sloria/sphinx-issues", "keywords": "sphinx issues github", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "sphinx-issues", "package_url": "https://pypi.org/project/sphinx-issues/", "platform": "", "project_url": "https://pypi.org/project/sphinx-issues/", "project_urls": { "Homepage": "https://github.com/sloria/sphinx-issues", "Issues": "https://github.com/sloria/sphinx-issues/issues" }, "release_url": "https://pypi.org/project/sphinx-issues/1.2.0/", "requires_dist": [ "sphinx", "pytest ; extra == 'dev'", "flake8 (==3.6.0) ; extra == 'dev'", "pre-commit (==1.13.0) ; extra == 'dev'", "tox ; extra == 'dev'", "mock ; (python_version < \"3.0\") and extra == 'dev'", "flake8-bugbear (==18.8.0) ; (python_version >= \"3.5\") and extra == 'dev'", "flake8 (==3.6.0) ; extra == 'lint'", "pre-commit (==1.13.0) ; extra == 'lint'", "flake8-bugbear (==18.8.0) ; (python_version >= \"3.5\") and extra == 'lint'", "pytest ; extra == 'tests'", "mock ; (python_version < \"3.0\") and extra == 'tests'" ], "requires_python": "", "summary": "A Sphinx extension for linking to your project's issue tracker", "version": "1.2.0" }, "last_serial": 4635603, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "a6c7031229416dfcef150174242435cc", "sha256": "d95e36ae94ffbaf0347e20f2a291dd2659420636d1392b364970355ad2c5fb5b" }, "downloads": -1, "filename": "sphinx_issues-0.1.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "a6c7031229416dfcef150174242435cc", "packagetype": "bdist_wheel", "python_version": "2.7", "requires_python": null, "size": 5511, "upload_time": "2014-12-21T19:40:58", "url": "https://files.pythonhosted.org/packages/fd/92/64748b4065c4e26e6fa091184b713e0c0cc304ceb186d9038938cf6a9359/sphinx_issues-0.1.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "0baec0935c05de52f0133698425687f4", "sha256": "1258e4db2dd632e778ac9660bd515eee824fd0d593324c97f69c4168553cfd01" }, "downloads": -1, "filename": "sphinx-issues-0.1.0.tar.gz", "has_sig": false, "md5_digest": "0baec0935c05de52f0133698425687f4", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3428, "upload_time": "2014-12-21T19:35:54", "url": "https://files.pythonhosted.org/packages/ef/8a/e44734f20572340604c9139fce9f861a24aa926424bd3b6cd69fa4b13985/sphinx-issues-0.1.0.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "29e569daa65f3a63598e30a92d18491a", "sha256": "1f951462ef748be778c779ac0a2a3ae07e62c348105d270792a01f1c257ab47b" }, "downloads": -1, "filename": "sphinx_issues-0.2.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "29e569daa65f3a63598e30a92d18491a", "packagetype": "bdist_wheel", "python_version": "2.7", "requires_python": null, "size": 6376, "upload_time": "2014-12-22T23:51:26", "url": "https://files.pythonhosted.org/packages/f7/93/5b1643608ac6c51a401fc8818887da453453bde8c6ee733821c5901645b6/sphinx_issues-0.2.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "6065e4538b8ead02e35a777711eab6f5", "sha256": "fd094090ab63defa8b37eae1ec7e56e8f5ed3ad130df79dddbe711b86f0f3cda" }, "downloads": -1, "filename": "sphinx-issues-0.2.0.tar.gz", "has_sig": false, "md5_digest": "6065e4538b8ead02e35a777711eab6f5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4082, "upload_time": "2014-12-22T23:51:22", "url": "https://files.pythonhosted.org/packages/bf/2b/fa4386a3f15c06791682f022114e3ffc8b3cd01f421e014899d90f960f6e/sphinx-issues-0.2.0.tar.gz" } ], "0.3.0": [ { "comment_text": "", "digests": { "md5": "83a7f9a3eb0420705188fbeaaeeb316d", "sha256": "e81b795b25802ed71a4fbf1f469b12cefbdf0da02e82df0cc2737b40bfc179ce" }, "downloads": -1, "filename": "sphinx_issues-0.3.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "83a7f9a3eb0420705188fbeaaeeb316d", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 6765, "upload_time": "2016-10-21T02:29:22", "url": "https://files.pythonhosted.org/packages/27/ca/2013c95a7e81883f1469ba55d046cb25b4453ae508a12ef4848970d65b0d/sphinx_issues-0.3.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "cafee80fac200caa7a6ea0e995837aa2", "sha256": "ca004cfefbc010b315c1d1a74a273c2460a60991b56d967d2ea3e19f93985105" }, "downloads": -1, "filename": "sphinx-issues-0.3.0.tar.gz", "has_sig": false, "md5_digest": "cafee80fac200caa7a6ea0e995837aa2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4392, "upload_time": "2016-10-21T02:29:24", "url": "https://files.pythonhosted.org/packages/41/91/6d205eae5c631f1c40b4d0ec14c1a3945705d6559bb9b9bb8fd689ac9dc4/sphinx-issues-0.3.0.tar.gz" } ], "0.3.1": [ { "comment_text": "", "digests": { "md5": "5eee0939f4ff034142c24121d0c1ad45", "sha256": "f8fd9c6e95fd19750fc6462ad2f99c4dc540bff657e79e9228944357fcb20e88" }, "downloads": -1, "filename": "sphinx_issues-0.3.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "5eee0939f4ff034142c24121d0c1ad45", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 6963, "upload_time": "2017-01-16T22:01:29", "url": "https://files.pythonhosted.org/packages/a0/63/aec4d762e0772f6ca08301a6961496c15384a6cce0541f5d16b55436e712/sphinx_issues-0.3.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "f0903a1b071fb8d19c434e36f8eac3dc", "sha256": "be43b12655dfa235b1e5d1c4d7a91f942918707f2e5400711fbc439893daa694" }, "downloads": -1, "filename": "sphinx-issues-0.3.1.tar.gz", "has_sig": false, "md5_digest": "f0903a1b071fb8d19c434e36f8eac3dc", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4524, "upload_time": "2017-01-16T22:01:30", "url": "https://files.pythonhosted.org/packages/39/37/7fc3e5fe6f64bf282e96ab2160bb01a71ae53a8d3d9ac5dfdf3243729acc/sphinx-issues-0.3.1.tar.gz" } ], "0.4.0": [ { "comment_text": "", "digests": { "md5": "06287296a7e6725aae3bd52e3f9b4fe4", "sha256": "f9741be540be92d6a5330ddb54506a4a2860ed07890635f0beb4c5eed19f65f4" }, "downloads": -1, "filename": "sphinx_issues-0.4.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "06287296a7e6725aae3bd52e3f9b4fe4", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 5822, "upload_time": "2017-11-25T14:33:04", "url": "https://files.pythonhosted.org/packages/3a/60/dbe19e0e400ad5ea19d68a51127923f92759edd020f9ad22b68db29e52a1/sphinx_issues-0.4.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "c9a9057be12dfc48507fbadc385dada2", "sha256": "f3ea900c2a696f873df3cfaa633d90407bba127ed9586a5f386ce2b266c3ea75" }, "downloads": -1, "filename": "sphinx-issues-0.4.0.tar.gz", "has_sig": false, "md5_digest": "c9a9057be12dfc48507fbadc385dada2", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4543, "upload_time": "2017-11-25T14:33:05", "url": "https://files.pythonhosted.org/packages/a6/e0/c5f18ec00c12e3dda64b7862bddfa10be98d47f9546c7f47c865cb21d6b2/sphinx-issues-0.4.0.tar.gz" } ], "1.0.0": [ { "comment_text": "", "digests": { "md5": "778cb6df6f36a702c8b29a12fffb49c2", "sha256": "50614da29b83868c506e5f482500bba46721cb4d5df6a9a79bbf627a8a5f7393" }, "downloads": -1, "filename": "sphinx_issues-1.0.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "778cb6df6f36a702c8b29a12fffb49c2", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 4049, "upload_time": "2018-07-14T22:51:23", "url": "https://files.pythonhosted.org/packages/e5/3c/a00b886d74ccc2e2b7a40b5baa3eb4fcf594ed6ff927261f51a5df18d6ea/sphinx_issues-1.0.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "975f77626ead31de2d39484d42c8c4e5", "sha256": "6e20b741041f4b130a674cb1cbe342bb91606d1c139924b3b28410dbb5477593" }, "downloads": -1, "filename": "sphinx-issues-1.0.0.tar.gz", "has_sig": false, "md5_digest": "975f77626ead31de2d39484d42c8c4e5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4950, "upload_time": "2018-07-14T22:51:24", "url": "https://files.pythonhosted.org/packages/51/97/bb6ef736ab55bc53ba42c4072c2ddaeac28b72aa3f345bfa261f4adb4cce/sphinx-issues-1.0.0.tar.gz" } ], "1.1.0": [ { "comment_text": "", "digests": { "md5": "61bad99f6a62587c89b0b2554fc06662", "sha256": "8c5496dca89e4d3b46a100ba5b83977ecfc1fff6b9305ccb391b0285c6e406bf" }, "downloads": -1, "filename": "sphinx_issues-1.1.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "61bad99f6a62587c89b0b2554fc06662", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 4184, "upload_time": "2018-09-19T02:57:07", "url": "https://files.pythonhosted.org/packages/b0/7b/20eb04f4ed42d6ba39620c1fde318cd85e8577246ea20f3743f0a045e6c2/sphinx_issues-1.1.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "417b538543f57dd69c2ddca0e7d23c30", "sha256": "16c883f921ca5b39114a6093611f88ccc01afcbdf6dd508d2af3ccb17886b3bd" }, "downloads": -1, "filename": "sphinx-issues-1.1.0.tar.gz", "has_sig": false, "md5_digest": "417b538543f57dd69c2ddca0e7d23c30", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5074, "upload_time": "2018-09-19T02:57:08", "url": "https://files.pythonhosted.org/packages/8c/4e/26e599742a947e923640f5a071489e66fdebcf33008a0a97c80a8fe98c0c/sphinx-issues-1.1.0.tar.gz" } ], "1.2.0": [ { "comment_text": "", "digests": { "md5": "ba79439c334876eb3187dde33e47284e", "sha256": "1208e1869742b7800a45b3c47ab987b87b2ad2024cbc36e0106e8bba3549dd22" }, "downloads": -1, "filename": "sphinx_issues-1.2.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "ba79439c334876eb3187dde33e47284e", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 5796, "upload_time": "2018-12-26T16:10:57", "url": "https://files.pythonhosted.org/packages/a2/cc/622a71c401b1abda6a1860ac4684e984846d1e597de24a72127ca99476d2/sphinx_issues-1.2.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "0f40881c9c95c40c6e752abce61882cc", "sha256": "845294736c7ac4c09c706f13431f709e1164037cbb00f6bf623ae16eccf509f3" }, "downloads": -1, "filename": "sphinx-issues-1.2.0.tar.gz", "has_sig": false, "md5_digest": "0f40881c9c95c40c6e752abce61882cc", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6037, "upload_time": "2018-12-26T16:10:59", "url": "https://files.pythonhosted.org/packages/ae/0a/933847eed21964b5ab13836e90ea445a95915eaf222d45489c84e18afa07/sphinx-issues-1.2.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "ba79439c334876eb3187dde33e47284e", "sha256": "1208e1869742b7800a45b3c47ab987b87b2ad2024cbc36e0106e8bba3549dd22" }, "downloads": -1, "filename": "sphinx_issues-1.2.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "ba79439c334876eb3187dde33e47284e", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 5796, "upload_time": "2018-12-26T16:10:57", "url": "https://files.pythonhosted.org/packages/a2/cc/622a71c401b1abda6a1860ac4684e984846d1e597de24a72127ca99476d2/sphinx_issues-1.2.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "0f40881c9c95c40c6e752abce61882cc", "sha256": "845294736c7ac4c09c706f13431f709e1164037cbb00f6bf623ae16eccf509f3" }, "downloads": -1, "filename": "sphinx-issues-1.2.0.tar.gz", "has_sig": false, "md5_digest": "0f40881c9c95c40c6e752abce61882cc", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6037, "upload_time": "2018-12-26T16:10:59", "url": "https://files.pythonhosted.org/packages/ae/0a/933847eed21964b5ab13836e90ea445a95915eaf222d45489c84e18afa07/sphinx-issues-1.2.0.tar.gz" } ] }