{
"info": {
"author": "Mike Bayer",
"author_email": "mike@zzzcomputing.com",
"bugtrack_url": null,
"classifiers": [
"Development Status :: 3 - Alpha",
"Environment :: Console",
"Intended Audience :: Developers",
"Programming Language :: Python",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: Implementation :: CPython",
"Programming Language :: Python :: Implementation :: PyPy",
"Topic :: Documentation"
],
"description": "==================\nSphinx Paramlinks\n==================\n\nA `Sphinx `_ extension which allows ``:param:``\ndirectives within Python documentation to be linkable.\n\nThis is an experimental, possibly-not-useful extension that's used by the\n`SQLAlchemy `_ project and related projects.\n\nConfiguration\n=============\n\nJust turn it on in ``conf.py``::\n\n extensions = [\n 'sphinx_paramlinks',\n\n # your other sphinx extensions\n # ...\n ]\n\nStylesheet\n==========\n\nThe paragraph link involves a short stylesheet, to allow the links to\nbe visible when hovered. This sheet is called\n``sphinx_paramlinks.css`` and the plugin will copy it to the ``_static``\ndirectory of the output automatically. The stylesheet is added to the\n``css_files`` list present in the template namespace for Sphinx via the\n``Sphinx.add_stylesheet()`` hook.\n\nFeatures\n========\n\n* ``:param:`` directives within Sphinx function/method descriptions\n will be given a paragraph link so that they can be linked\n to externally.\n\n* A new text role ``:paramref:`` is added, which works like ``:meth:``,\n ``:func:``, etc. Just append the parameter name as an additional token::\n\n :paramref:`.EnvironmentContext.configure.transactional_ddl`\n\n The directive makes use of the existing Python role to do the method/function\n lookup, searching first the ``:meth:``, then the ``:class:``, and then the\n ``:func:`` role; then the parameter name is applied separately to produce the\n final reference link. (new in 0.3.4, search for ``:meth:`` / ``:func:`` /\n ``:class:`` individually rather than using ``:obj:`` which catches lots of\n things that don't have parameters)\n\n* The paramlinks are also added to the master index as well as the list\n of domain objects, which allows them to be searchable through the\n searchindex.js system. (new in 0.3.0)\n\nCompatibility\n=============\n\nPython Compatibility\n--------------------\n\nThe extension was developed on Python 2.7, but is compatible with at least\nPython 3.3 as well. It contains one ``u''`` literal - these are supported again\nas of Python 3.3.\n\nSphinx Compatibility\n--------------------\n\nI've tried *very* hard to make as few assumptions as possible about Sphinx\nand to use only very simple public APIs, so that architectural changes in future\nSphinx versions won't break this plugin. To come up with this plugin I\nspent many hours with Sphinx source and tried many different approaches to\nvarious elements of functionality; hopefully what's here is as simple and\nstable as possible based on the current extension capabilities of Sphinx.\n\nOne element that involves using a bit of internals is the usage of the\n``sphinx.domains.python.PyXRefRole`` class, which is currently the\nSphinx class that defines roles for things like ``:meth:``,\n``:func:``, etc. The object is used as-is in order to define the\n``:paramref:`` role; the product of this role is later transformed\nusing standard hooks.\n\nAnother assumption is that in order to locate the RST nodes Sphinx\ncreates for the ``:param:`` tags, we look at ``nodes.strong``,\nassuming that this is the type of node currently used to render\n``:param:`` within RST. If this changes, or needs to be expanded to\nsupport other domains, this traversal can be opened up as needed.\nThis part was difficult as Sphinx really doesn't provide any hooks\ninto how the \"Info Field List\" aspect of domains is handled.\n\nOverall, the approach here is to apply extra information to constructs\ngoing into the Sphinx system, then do some transformations as the data\ncomes back out. This relies on as little of how Sphinx does its\nthing as possible, rather than going with custom domains and heavy use\nof injected APIs which may change in future releases.\n\nFuture Enhancements / Missing Features\n======================================\n\nThe extension currently does only ``:param:`` elements within the\nPython role, but could also be expanded to support other Python role\nelements such as ``:returns:``, ``:raises:``, etc., and perhaps also\ncould be made to support similar features in other roles.",
"description_content_type": "",
"docs_url": null,
"download_url": "",
"downloads": {
"last_day": -1,
"last_month": -1,
"last_week": -1
},
"home_page": "http://github.com/sqlalchemyorg/sphinx-paramlinks",
"keywords": "sphinx",
"license": "MIT",
"maintainer": "",
"maintainer_email": "",
"name": "sphinx-paramlinks",
"package_url": "https://pypi.org/project/sphinx-paramlinks/",
"platform": "",
"project_url": "https://pypi.org/project/sphinx-paramlinks/",
"project_urls": {
"Homepage": "http://github.com/sqlalchemyorg/sphinx-paramlinks"
},
"release_url": "https://pypi.org/project/sphinx-paramlinks/0.3.7/",
"requires_dist": null,
"requires_python": "",
"summary": "Allows param links in Sphinx function/method descriptions to be linkable",
"version": "0.3.7"
},
"last_serial": 4895021,
"releases": {
"0.1.0": [
{
"comment_text": "",
"digests": {
"md5": "89c047a9adfadb0f38b3d8c24c8bbf28",
"sha256": "db4e9e1501169eaaff636ed7f5eb34ee97549d6ec1a95c5f520c8b189577e14e"
},
"downloads": -1,
"filename": "sphinx-paramlinks-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "89c047a9adfadb0f38b3d8c24c8bbf28",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 6490,
"upload_time": "2013-12-30T17:22:39",
"url": "https://files.pythonhosted.org/packages/17/36/5cd9e287baad47da8b7ff15360b47a6c09c0a8d1cb9dd923314cb6d421cf/sphinx-paramlinks-0.1.0.tar.gz"
}
],
"0.1.1": [
{
"comment_text": "",
"digests": {
"md5": "83a263d8f07da5295f45dbf7f1e2876c",
"sha256": "34d09daa3179598e95efeff7404f1dcd0cf801e6bcff0893b315def46ca454c9"
},
"downloads": -1,
"filename": "sphinx-paramlinks-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "83a263d8f07da5295f45dbf7f1e2876c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 6511,
"upload_time": "2013-12-30T17:48:19",
"url": "https://files.pythonhosted.org/packages/a1/e0/fd50febda58ff7f90c4a62b6a2c9317a57a14441ddd00aa04b41fdb791fc/sphinx-paramlinks-0.1.1.tar.gz"
}
],
"0.1.3": [
{
"comment_text": "",
"digests": {
"md5": "c2c88bb8b27ffd5b6abb9b4a4f659d50",
"sha256": "456ada029467579ddb954c003783b354a1e34f4fb4d730def198f26e16823e4d"
},
"downloads": -1,
"filename": "sphinx-paramlinks-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "c2c88bb8b27ffd5b6abb9b4a4f659d50",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 6537,
"upload_time": "2013-12-30T17:51:08",
"url": "https://files.pythonhosted.org/packages/62/2b/ffcb36b2dae07b3d8d50d247c1ae8b04fbdeda26f60d6bf59a1fd05abba0/sphinx-paramlinks-0.1.3.tar.gz"
}
],
"0.1.4": [
{
"comment_text": "",
"digests": {
"md5": "1043ea53c62d3db86ed6621214fa9724",
"sha256": "4c434f53c66ab4f13165ca5d9990443a20ee867ad98d32215808eee4f9d0b071"
},
"downloads": -1,
"filename": "sphinx-paramlinks-0.1.4.tar.gz",
"has_sig": false,
"md5_digest": "1043ea53c62d3db86ed6621214fa9724",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 6559,
"upload_time": "2013-12-30T17:55:19",
"url": "https://files.pythonhosted.org/packages/6a/5b/da83d75ad2fec4a01cf16cec85f084b276d119fdf6004fb0c6a6308c8ae6/sphinx-paramlinks-0.1.4.tar.gz"
}
],
"0.1.5": [
{
"comment_text": "",
"digests": {
"md5": "7066839ae78e076ba0c31d69489de0ee",
"sha256": "93f118870811f607123c46aa493636fec575132457fbcf3c4ad97f02c36b872c"
},
"downloads": -1,
"filename": "sphinx-paramlinks-0.1.5.tar.gz",
"has_sig": false,
"md5_digest": "7066839ae78e076ba0c31d69489de0ee",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 6552,
"upload_time": "2013-12-30T17:59:49",
"url": "https://files.pythonhosted.org/packages/a7/ba/699220f6f5d8ff0643734cf7824ee8d640812edd259fcc34c666acd80572/sphinx-paramlinks-0.1.5.tar.gz"
}
],
"0.1.6": [
{
"comment_text": "",
"digests": {
"md5": "5e9f60eb5c22bdae577752bf803a50b1",
"sha256": "ee017515bff87ab0c1471ad331bea1b5cf01eba55d5027930776ef31fc133499"
},
"downloads": -1,
"filename": "sphinx-paramlinks-0.1.6.tar.gz",
"has_sig": false,
"md5_digest": "5e9f60eb5c22bdae577752bf803a50b1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 6719,
"upload_time": "2013-12-30T18:11:37",
"url": "https://files.pythonhosted.org/packages/3f/2a/30198a75e16576139bd36d4e45c92dbba45be57340f9b0b58acf1b40607c/sphinx-paramlinks-0.1.6.tar.gz"
}
],
"0.1.7": [
{
"comment_text": "",
"digests": {
"md5": "16585e27e8fda4c8434c474d2377de8a",
"sha256": "785d6dc9e1a49292226ff4372c41edef3d2169f55c08bd8363914ae709ee76e0"
},
"downloads": -1,
"filename": "sphinx-paramlinks-0.1.7.tar.gz",
"has_sig": false,
"md5_digest": "16585e27e8fda4c8434c474d2377de8a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 6714,
"upload_time": "2013-12-30T18:18:26",
"url": "https://files.pythonhosted.org/packages/5d/00/9973b0ddff738133f4040249788142b65c9c564bf605d85cea02fc23131e/sphinx-paramlinks-0.1.7.tar.gz"
}
],
"0.1.8": [
{
"comment_text": "",
"digests": {
"md5": "1370c8e0827247fac839ee046d0caea4",
"sha256": "40e4783c83463553770f101e752b343a6ecc2ad4c5dfb0cc19ee3f83c7622fd1"
},
"downloads": -1,
"filename": "sphinx-paramlinks-0.1.8.tar.gz",
"has_sig": false,
"md5_digest": "1370c8e0827247fac839ee046d0caea4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 6751,
"upload_time": "2013-12-30T18:46:14",
"url": "https://files.pythonhosted.org/packages/b4/97/0e189cc0c0ed15c11e220bdbb57053a77c4ce505f29a2eb1a0823aa57ffb/sphinx-paramlinks-0.1.8.tar.gz"
}
],
"0.1.9": [
{
"comment_text": "",
"digests": {
"md5": "f53d6184db31bd6d683bd97ba5a4ae65",
"sha256": "fd8bfff4024918f2797cc76343c17092152c1afb07f9c10ea1d359911a415f68"
},
"downloads": -1,
"filename": "sphinx-paramlinks-0.1.9.tar.gz",
"has_sig": false,
"md5_digest": "f53d6184db31bd6d683bd97ba5a4ae65",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 6780,
"upload_time": "2014-01-05T02:13:30",
"url": "https://files.pythonhosted.org/packages/62/09/f2df68841625e8c9afc86a33f9248a4fba69139df12aa4f79ab36405028c/sphinx-paramlinks-0.1.9.tar.gz"
}
],
"0.2.0": [
{
"comment_text": "",
"digests": {
"md5": "16c9a40c7393d88f7eda80510161b48e",
"sha256": "d6642a993c512e221a99d9d4701c811969c9b922c3798737ff2e127db5ad27f2"
},
"downloads": -1,
"filename": "sphinx-paramlinks-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "16c9a40c7393d88f7eda80510161b48e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 6817,
"upload_time": "2014-01-05T21:28:33",
"url": "https://files.pythonhosted.org/packages/e3/16/f7b0023c6397892b655506004113863ee641a2d1f39a3c28de6b68f11422/sphinx-paramlinks-0.2.0.tar.gz"
}
],
"0.2.1": [
{
"comment_text": "",
"digests": {
"md5": "f1db3dd5a9debbf32dfc74c82cd06de9",
"sha256": "ddf8658929390dcbc7c85f6fa28c9f24089c95a7e4e099667d747f5476c1034e"
},
"downloads": -1,
"filename": "sphinx-paramlinks-0.2.1.tar.gz",
"has_sig": false,
"md5_digest": "f1db3dd5a9debbf32dfc74c82cd06de9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 6931,
"upload_time": "2014-01-20T22:54:19",
"url": "https://files.pythonhosted.org/packages/35/b0/5da2cbfa2d33865631a12c6fdfcf31100632a89ef89813fe7062f39a067c/sphinx-paramlinks-0.2.1.tar.gz"
}
],
"0.2.2": [
{
"comment_text": "",
"digests": {
"md5": "3e0a74b325b1cb65e917671a3790da7e",
"sha256": "7ac904f509563d810d00dc111bc8a95d39e62549b2ebe88c736ce32e2a1d3bfe"
},
"downloads": -1,
"filename": "sphinx-paramlinks-0.2.2.tar.gz",
"has_sig": false,
"md5_digest": "3e0a74b325b1cb65e917671a3790da7e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 6871,
"upload_time": "2014-01-20T23:31:14",
"url": "https://files.pythonhosted.org/packages/ec/2f/09ac4c15f7f01d9f9ffa323d2576d662388363428541b58904d4c181ef2f/sphinx-paramlinks-0.2.2.tar.gz"
}
],
"0.3.0": [
{
"comment_text": "",
"digests": {
"md5": "734056132fcb5878e0d1240bc7af8773",
"sha256": "c4b9f37c0b89acf55a620c5c2d9ba4d097aa7ee7d1733961770fa552664606c2"
},
"downloads": -1,
"filename": "sphinx-paramlinks-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "734056132fcb5878e0d1240bc7af8773",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 7485,
"upload_time": "2016-01-07T20:25:50",
"url": "https://files.pythonhosted.org/packages/d7/80/29010088a3311ce0315f85258758245f2cd6693a72f12874ec9b5984e7d8/sphinx-paramlinks-0.3.0.tar.gz"
}
],
"0.3.1": [
{
"comment_text": "",
"digests": {
"md5": "782aaf890ffc4b5b151a9159c866e9a6",
"sha256": "c1b814f9159fb8f3c755c47ad2c48dfff36ea4579d86180dce814d8e8c720718"
},
"downloads": -1,
"filename": "sphinx-paramlinks-0.3.1.tar.gz",
"has_sig": false,
"md5_digest": "782aaf890ffc4b5b151a9159c866e9a6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 7517,
"upload_time": "2016-01-07T21:03:30",
"url": "https://files.pythonhosted.org/packages/25/59/22b959f9a042001de3df7e5f056785351de0b4bd56fb8dd645744a7c54c3/sphinx-paramlinks-0.3.1.tar.gz"
}
],
"0.3.2": [
{
"comment_text": "",
"digests": {
"md5": "0bcae330c4d6d538797a65b431971966",
"sha256": "028f889c1aea759e757b1eba181a6013a8cc02d405f6ae81819d1a72d23f96bb"
},
"downloads": -1,
"filename": "sphinx-paramlinks-0.3.2.tar.gz",
"has_sig": false,
"md5_digest": "0bcae330c4d6d538797a65b431971966",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 7582,
"upload_time": "2016-05-10T18:59:48",
"url": "https://files.pythonhosted.org/packages/68/66/35fd8994e7c380f0272af0fc4b729272fd61a5f209a5ca4b2ee38d92ca68/sphinx-paramlinks-0.3.2.tar.gz"
}
],
"0.3.3": [
{
"comment_text": "",
"digests": {
"md5": "4d73e21078f5f17ceee36eec2d6c7600",
"sha256": "e1b8994a94ba0b3d4217376f548fdacd2b0aefc217ccc2fb0511e5979b745580"
},
"downloads": -1,
"filename": "sphinx-paramlinks-0.3.3.tar.gz",
"has_sig": false,
"md5_digest": "4d73e21078f5f17ceee36eec2d6c7600",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 7676,
"upload_time": "2017-05-02T20:37:31",
"url": "https://files.pythonhosted.org/packages/36/d2/806c8102a620d0b247338525901a05a2bbab2b4cb4c1143e0df36ef99ace/sphinx-paramlinks-0.3.3.tar.gz"
}
],
"0.3.4": [
{
"comment_text": "",
"digests": {
"md5": "023b3a3e4d1ccf47008db1ffc62e71bb",
"sha256": "b423c9401a42af3594730c7d57f7e40b2029d93bae26a49c759699ccd2ebb5a6"
},
"downloads": -1,
"filename": "sphinx-paramlinks-0.3.4.tar.gz",
"has_sig": false,
"md5_digest": "023b3a3e4d1ccf47008db1ffc62e71bb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 7688,
"upload_time": "2017-05-05T13:16:44",
"url": "https://files.pythonhosted.org/packages/ef/f1/0c4ab500de225dd669c1c1c5ce3cb360ea0c104e322c3f342b31706f7c05/sphinx-paramlinks-0.3.4.tar.gz"
}
],
"0.3.5": [
{
"comment_text": "",
"digests": {
"md5": "7d94e5ee720eecd99d00cc3f9354a93e",
"sha256": "7a09cd43910a57a60d6fee3c791723d4c69dc13235fb1279d28940a93e5078f1"
},
"downloads": -1,
"filename": "sphinx-paramlinks-0.3.5.tar.gz",
"has_sig": false,
"md5_digest": "7d94e5ee720eecd99d00cc3f9354a93e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 7715,
"upload_time": "2018-09-28T22:08:38",
"url": "https://files.pythonhosted.org/packages/43/8b/f64d09645cb57d2c1c7bef3cbc7dd0e10e0e5745651f1c1da412ba0f98a4/sphinx-paramlinks-0.3.5.tar.gz"
}
],
"0.3.6": [
{
"comment_text": "",
"digests": {
"md5": "e443a48ee0b7f81fb76c06b3516c0d84",
"sha256": "3a659f76a92d9f9817f0eebc15e0b11e30b925f00a8d9b65b0c934dba7a6ef44"
},
"downloads": -1,
"filename": "sphinx-paramlinks-0.3.6.tar.gz",
"has_sig": false,
"md5_digest": "e443a48ee0b7f81fb76c06b3516c0d84",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 7614,
"upload_time": "2019-02-28T16:15:09",
"url": "https://files.pythonhosted.org/packages/0d/d1/9ab15f5e708401cd11d0c391d4fc4a3d4c98159b554f71d53ad71213255d/sphinx-paramlinks-0.3.6.tar.gz"
}
],
"0.3.7": [
{
"comment_text": "",
"digests": {
"md5": "373d5849a2d844e82b18a89e7c1efdca",
"sha256": "40316489688b5904886bac38ff19978e5d8fe77b5146884299b569ecfab96b7d"
},
"downloads": -1,
"filename": "sphinx-paramlinks-0.3.7.tar.gz",
"has_sig": false,
"md5_digest": "373d5849a2d844e82b18a89e7c1efdca",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 7665,
"upload_time": "2019-03-04T15:44:47",
"url": "https://files.pythonhosted.org/packages/6b/0b/21552e2f7fe64dc682f70b534e66f777bcc1595dcd7d9ca6e4f4c3646176/sphinx-paramlinks-0.3.7.tar.gz"
}
]
},
"urls": [
{
"comment_text": "",
"digests": {
"md5": "373d5849a2d844e82b18a89e7c1efdca",
"sha256": "40316489688b5904886bac38ff19978e5d8fe77b5146884299b569ecfab96b7d"
},
"downloads": -1,
"filename": "sphinx-paramlinks-0.3.7.tar.gz",
"has_sig": false,
"md5_digest": "373d5849a2d844e82b18a89e7c1efdca",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 7665,
"upload_time": "2019-03-04T15:44:47",
"url": "https://files.pythonhosted.org/packages/6b/0b/21552e2f7fe64dc682f70b534e66f777bcc1595dcd7d9ca6e4f4c3646176/sphinx-paramlinks-0.3.7.tar.gz"
}
]
}