{ "info": { "author": "Chintalagiri Shashank", "author_email": "shashank@chintal.in", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Environment :: Console", "Environment :: Web Environment", "Framework :: Sphinx :: Extension", "Intended Audience :: Developers", "License :: OSI Approved :: BSD License", "Operating System :: OS Independent", "Programming Language :: Python", "Topic :: Documentation", "Topic :: Utilities" ], "description": "DocumentedList Sphinx Extension\n===============================\n\nThis file provides a Sphinx extension to convert a Python list into\na table in the generated documentation. The intended application of\nthis extension is to document the items of essentially list-like\nobjects of immutable data (possibly enums, though python 3.4 enums\nare not supported yet).\n\nIn the source code, each list item, instead of being just it's native\ndata type, should be replaced by a tuple of two elements. In the\nsimpest application, the second element of the tuple should be a string\nwhich provides a description for the item.\n\nThe following options are also included to enable slightly more complex\nuse cases :\n\n\n:header: The number of columns displayed is 2 by default, with titles\n \"Item\" and \"Description\". This option allows you to add a custom\n header and change the number of columns in the table::\n\n .. documentedlist::\n :listobject: some.list.object\n :header: \"First Name\" \"Last Name\" Email\n\n\n:spantolast: If this flag is present, the last column of any row with\n an insufficient number of columns will spread to span all remaining\n columns. This would typically be used to insert headings within\n the table::\n\n .. documentedlist::\n :listobject: some.list.object\n :spantolast:\n\n\n:descend: This flag allows you to construct a relatively complex table.\n with subsections. Any row containing a list as one of it's cells is\n expanded into a sub-table (specifically, a docutils tgroup). The\n list is popped from the original row, and each element of the list\n is turned into a row::\n\n .. documentedlist::\n :listobject: some.list.object\n :descend:\n\n\nIn the first use of this extension, the aim was to document a list of\nsupported device classes (each of which is a string). This was\noriginally specified in the python code as a list, and the same list\nwith descriptions was manually maintained (or, in reality, left\nunmaintained) in the corresponding documentation. The list is now\nreplaced with a tuple containing both the recognized strings and the\ndescription for each, and Sphinx is able to use this extension to\n'autogenerate' the table in the documentation.\n\nBased heavily on slides from Doug Hellman's PyCon talk,\nhttp://www.slideshare.net/doughellmann/better-documentation-through-automation-creating-docutils-sphinx-extensions\n\nInstallation & Usage\n--------------------\n\nThis extension is part of the sphinxcontrib namespace and can be\ninstalled from pypi :\n\n .. code-block:: bash\n\n pip install sphinxcontrib-documentedlist\n\nIn the .rst file where the table should appear, insert the Sphinx\ndirective provided by this module :\n\n .. code-block:: rest\n\n .. documentedlist::\n :listobject: full.importable.path.of.thelist\n\nThis extension will import the list as :\n\n .. code-block:: python\n\n from full.importable.path.of import thelist\n\nFor a basic usage example, see:\n\n:Python: https://github.com/chintal/tendril/blob/master/tendril/conventions/electronics.py#L28\n:ReST: https://raw.githubusercontent.com/chintal/tendril/master/doc/userdoc/conventions/gedasymbols.rst (Device Classes)\n:Generated: http://tendril.chintal.in/doc/userdoc/conventions/gedasymbols/#device-classes\n\nFor a more complex example of the extension's usage, including the\n:header:, :spantolast:, and :descend: options, see:\n\n:Python: https://github.com/chintal/tendril/blob/master/tendril/utils/config.py#L791\n:ReST: https://github.com/chintal/tendril/blob/master/tendril/utils/config.py#L67\n:Generated: http://tendril.chintal.in/doc/apidoc/tendril.utils.config/#configuration-options\n\n\nLicense\n-------\n\nThis Sphinx Extension is made available under the BSD 2-clause License. See\nsphinxcontrib's LICENSE file for the full text.\n\nThanks\n------\n\n - Maximilian Hils (github @mhils)", "description_content_type": null, "docs_url": null, "download_url": "http://pypi.python.org/pypi/sphinxcontrib-documentedlist", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/chintal/sphinxcontrib-documentedlist", "keywords": null, "license": "BSD", "maintainer": null, "maintainer_email": null, "name": "sphinxcontrib-documentedlist", "package_url": "https://pypi.org/project/sphinxcontrib-documentedlist/", "platform": "any", "project_url": "https://pypi.org/project/sphinxcontrib-documentedlist/", "project_urls": { "Download": "http://pypi.python.org/pypi/sphinxcontrib-documentedlist", "Homepage": "https://github.com/chintal/sphinxcontrib-documentedlist" }, "release_url": "https://pypi.org/project/sphinxcontrib-documentedlist/0.6/", "requires_dist": null, "requires_python": null, "summary": "Sphinx DocumentedList extension", "version": "0.6" }, "last_serial": 4745624, "releases": { "0.1": [ { "comment_text": "", "digests": { "md5": "d423ab3934bae1e90f0b69c8048ebf29", "sha256": "d1e930e7830dd3673be6cebe58a082faa66fdb94aa90d2d35c736b99d375addf" }, "downloads": -1, "filename": "sphinxcontrib_documentedlist-0.1-py2-none-any.whl", "has_sig": true, "md5_digest": "d423ab3934bae1e90f0b69c8048ebf29", "packagetype": "bdist_wheel", "python_version": "2.7", "requires_python": null, "size": 6441, "upload_time": "2015-08-29T10:52:21", "url": "https://files.pythonhosted.org/packages/23/c7/a3f638958f8132efedb00e2532698c08562456657ed520d6dfe7436a88db/sphinxcontrib_documentedlist-0.1-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "f9b9a6de3b1c6579624ec4f0b9b6326f", "sha256": "b148237abc87abace57f023627cb717ca3e2c94d9ed838cada74332cb6c62216" }, "downloads": -1, "filename": "sphinxcontrib-documentedlist-0.1.tar.gz", "has_sig": true, "md5_digest": "f9b9a6de3b1c6579624ec4f0b9b6326f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3911, "upload_time": "2015-08-29T10:52:11", "url": "https://files.pythonhosted.org/packages/56/de/5a5fa0f6a571de27720a451ca9101f610b191da95081ae39b8c00b5315d7/sphinxcontrib-documentedlist-0.1.tar.gz" } ], "0.2": [ { "comment_text": "", "digests": { "md5": "8f73811dcc65760d6eefd3c9d60edfc3", "sha256": "f50c6b48ee7cad7a9f4701992d8b23131726438f717a0890f3cda6070ff05de7" }, "downloads": -1, "filename": "sphinxcontrib_documentedlist-0.2-py2-none-any.whl", "has_sig": true, "md5_digest": "8f73811dcc65760d6eefd3c9d60edfc3", "packagetype": "bdist_wheel", "python_version": "2.7", "requires_python": null, "size": 6824, "upload_time": "2015-09-07T12:32:43", "url": "https://files.pythonhosted.org/packages/34/eb/b4725baccd75b5dd76e94d92dbf41f1b4d34c80ad5e32dcfaa8108a3e4db/sphinxcontrib_documentedlist-0.2-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "30cc25ccf4ed88b9f1c2c2dd264867ee", "sha256": "4736dbca0c0e17e1633659726eaba6817e74d21bd4cb4d67cfbe540588fdb6b3" }, "downloads": -1, "filename": "sphinxcontrib-documentedlist-0.2.tar.gz", "has_sig": true, "md5_digest": "30cc25ccf4ed88b9f1c2c2dd264867ee", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4232, "upload_time": "2015-09-07T12:32:36", "url": "https://files.pythonhosted.org/packages/05/0a/00fc1a06dae66e4ef76ba11b0387e47fb8be703ff4106a8689da94e42181/sphinxcontrib-documentedlist-0.2.tar.gz" } ], "0.3": [ { "comment_text": "", "digests": { "md5": "9b9fa55f5f921501e979474204f88528", "sha256": "0a0832deb5bd158473115e00cb9bff70dca703767e82e655bfcc65e4696c23a8" }, "downloads": -1, "filename": "sphinxcontrib_documentedlist-0.3-py2-none-any.whl", "has_sig": true, "md5_digest": "9b9fa55f5f921501e979474204f88528", "packagetype": "bdist_wheel", "python_version": "2.7", "requires_python": null, "size": 7759, "upload_time": "2015-09-26T23:56:28", "url": "https://files.pythonhosted.org/packages/f1/62/5a7d86782b104ac9a88d0920a2c473fa510ad6a024ac20f28f2eb1035754/sphinxcontrib_documentedlist-0.3-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "6a54c10d30cac2d80a1bbbb69396edf1", "sha256": "6f20c15d040cf49e49da414d5fd22620a0eeaa4919451ea85a4df85c2887a3db" }, "downloads": -1, "filename": "sphinxcontrib-documentedlist-0.3.tar.gz", "has_sig": true, "md5_digest": "6a54c10d30cac2d80a1bbbb69396edf1", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5010, "upload_time": "2015-09-26T23:56:20", "url": "https://files.pythonhosted.org/packages/98/f1/49e197727a69a702e4c4a49b34477c4059b6b3ded1deacb487d4201cc359/sphinxcontrib-documentedlist-0.3.tar.gz" } ], "0.4": [ { "comment_text": "", "digests": { "md5": "bc6b078da1e8d754227854abf26a0a86", "sha256": "46291258d5ed0a58bcf5d62621189c3c568514f86fff3ae2ecb4adfea273b21b" }, "downloads": -1, "filename": "sphinxcontrib-documentedlist-0.4.tar.gz", "has_sig": true, "md5_digest": "bc6b078da1e8d754227854abf26a0a86", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4821, "upload_time": "2016-06-29T04:56:17", "url": "https://files.pythonhosted.org/packages/0e/73/b32d730fde8cb2dd5f3ddb892cd74237b6174cb79bbd06da28a953dd4d7f/sphinxcontrib-documentedlist-0.4.tar.gz" } ], "0.5": [ { "comment_text": "", "digests": { "md5": "0d278a8b7a8b522c25ecb26eb28d550c", "sha256": "e6ed0a9695bedee306f3e3d6317215ef356af4fab51c7e219875a4fb9e42636f" }, "downloads": -1, "filename": "sphinxcontrib_documentedlist-0.5-py2-none-any.whl", "has_sig": true, "md5_digest": "0d278a8b7a8b522c25ecb26eb28d550c", "packagetype": "bdist_wheel", "python_version": "2.7", "requires_python": null, "size": 8044, "upload_time": "2016-12-30T07:33:32", "url": "https://files.pythonhosted.org/packages/67/b2/5e142b77dc93fefcb0507eb1a93ba363fd28dbd27faad42567058a221368/sphinxcontrib_documentedlist-0.5-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "b92bad385ff455d57535cd95a073df9c", "sha256": "a87bf70d6ff3c0c81daeb0b4459ab760b8dbdd61b05c31aa9609f354d172b88f" }, "downloads": -1, "filename": "sphinxcontrib-documentedlist-0.5.tar.gz", "has_sig": true, "md5_digest": "b92bad385ff455d57535cd95a073df9c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4978, "upload_time": "2016-12-30T07:33:23", "url": "https://files.pythonhosted.org/packages/5b/50/8b624e419392439a015ca64eb1249ace46bc9e709c6aab880cdf2e86e49f/sphinxcontrib-documentedlist-0.5.tar.gz" } ], "0.6": [ { "comment_text": "", "digests": { "md5": "2bbe95d735566a1f3f16e58d59c562e3", "sha256": "ea545729c8b22d32027e6b7632bd71e662c5042e03cf7afd6891b92ae127b18d" }, "downloads": -1, "filename": "sphinxcontrib_documentedlist-0.6-py2-none-any.whl", "has_sig": true, "md5_digest": "2bbe95d735566a1f3f16e58d59c562e3", "packagetype": "bdist_wheel", "python_version": "2.7", "requires_python": null, "size": 8057, "upload_time": "2017-03-09T10:16:49", "url": "https://files.pythonhosted.org/packages/59/1c/79f6a364b4e31a030e63b2997aa75625e6d7a451c4612992f421dbcceb70/sphinxcontrib_documentedlist-0.6-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "3cb0195672c0b61a7bcc1c4c55f57532", "sha256": "d0150b6118e156cc94569ca4b9a445ef18749ba26088c1a0470bdbcdc89fa526" }, "downloads": -1, "filename": "sphinxcontrib_documentedlist-0.6-py3-none-any.whl", "has_sig": true, "md5_digest": "3cb0195672c0b61a7bcc1c4c55f57532", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 6469, "upload_time": "2019-01-27T09:16:46", "url": "https://files.pythonhosted.org/packages/26/fc/6629fac55f24a9497c41f91f533f021ee5e6161f6d6f3a1b79bd3e03f065/sphinxcontrib_documentedlist-0.6-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "1264cfb59fe7e25d6a47ab0fd25f81f3", "sha256": "0ca2009a577b3e3b2a5dabef8c0e2d5067be8ffda84f893ca356a8a9784fc21a" }, "downloads": -1, "filename": "sphinxcontrib-documentedlist-0.6.tar.gz", "has_sig": true, "md5_digest": "1264cfb59fe7e25d6a47ab0fd25f81f3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4983, "upload_time": "2017-03-09T10:16:39", "url": "https://files.pythonhosted.org/packages/54/5b/7ad0611265968605e2d188376b2ee729716d781d5e9b184bb559180b29b2/sphinxcontrib-documentedlist-0.6.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "2bbe95d735566a1f3f16e58d59c562e3", "sha256": "ea545729c8b22d32027e6b7632bd71e662c5042e03cf7afd6891b92ae127b18d" }, "downloads": -1, "filename": "sphinxcontrib_documentedlist-0.6-py2-none-any.whl", "has_sig": true, "md5_digest": "2bbe95d735566a1f3f16e58d59c562e3", "packagetype": "bdist_wheel", "python_version": "2.7", "requires_python": null, "size": 8057, "upload_time": "2017-03-09T10:16:49", "url": "https://files.pythonhosted.org/packages/59/1c/79f6a364b4e31a030e63b2997aa75625e6d7a451c4612992f421dbcceb70/sphinxcontrib_documentedlist-0.6-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "3cb0195672c0b61a7bcc1c4c55f57532", "sha256": "d0150b6118e156cc94569ca4b9a445ef18749ba26088c1a0470bdbcdc89fa526" }, "downloads": -1, "filename": "sphinxcontrib_documentedlist-0.6-py3-none-any.whl", "has_sig": true, "md5_digest": "3cb0195672c0b61a7bcc1c4c55f57532", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 6469, "upload_time": "2019-01-27T09:16:46", "url": "https://files.pythonhosted.org/packages/26/fc/6629fac55f24a9497c41f91f533f021ee5e6161f6d6f3a1b79bd3e03f065/sphinxcontrib_documentedlist-0.6-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "1264cfb59fe7e25d6a47ab0fd25f81f3", "sha256": "0ca2009a577b3e3b2a5dabef8c0e2d5067be8ffda84f893ca356a8a9784fc21a" }, "downloads": -1, "filename": "sphinxcontrib-documentedlist-0.6.tar.gz", "has_sig": true, "md5_digest": "1264cfb59fe7e25d6a47ab0fd25f81f3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4983, "upload_time": "2017-03-09T10:16:39", "url": "https://files.pythonhosted.org/packages/54/5b/7ad0611265968605e2d188376b2ee729716d781d5e9b184bb559180b29b2/sphinxcontrib-documentedlist-0.6.tar.gz" } ] }