{ "info": { "author": "Brian Mearns", "author_email": "bmearns@ieee.org", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", "Natural Language :: English", "Operating System :: OS Independent" ], "description": "=================================================================\r\ndocit\r\n=================================================================\r\n\r\n.. # POST TITLE\r\n.. # BEGIN BADGES\r\n\r\n|pypi-version-badge| |license-badge| |pypi-downloads-badge|\r\n\r\n.. |pypi-version-badge| image:: http://img.shields.io/pypi/v/docit.svg\r\n :alt: [latest version on pypi]\r\n :target: https://pypi.python.org/pypi/docit\r\n\r\n.. |pypi-downloads-badge| image:: http://img.shields.io/pypi/dm/docit.svg\r\n :alt: [downloads on pypi]\r\n :target: https://pypi.python.org/pypi/docit\r\n\r\n.. |license-badge| image:: http://img.shields.io/badge/license-GPLv3+-brightgreen.svg\r\n :alt: [GPLv3+]\r\n :target: https://www.gnu.org/licenses/gpl.html\r\n\r\n\r\n.. # END BADGES\r\n\r\n\r\n**docit** is a python package which provides some simple tools to use with sphinx\r\nautodoc to control whether or not members are included in the documentation or not.\r\n\r\n\r\n.. contents:: **Page Contents**\r\n :local:\r\n :depth: 2\r\n :backlinks: top\r\n\r\ntl;dr\r\n---------------\r\n\r\nWhat?\r\n~~~~~~~~~~~~~~\r\n\r\nA `sphinx `_ extension to control autodoc for individual\r\nmembers.\r\n\r\nInstall?\r\n~~~~~~~~~~~~~\r\n\r\n.. code:: bash\r\n\r\n $ pip install docit\r\n\r\nOr, from source:\r\n\r\n.. code:: bash\r\n\r\n $ python setup.py install\r\n\r\n\r\nExamples?\r\n~~~~~~~~~~~~~~~~~~\r\n\r\n.. todo::\r\n Example code\r\n\r\n.. code:: python\r\n\r\n >>> import docit\r\n >>>\r\n\r\nDependencies?\r\n~~~~~~~~~~~~~~~~\r\n\r\ndocit is developed against `python `_ version 2.7.\r\n\r\nTo build the sphinx docs from source (as is), you'll need the `sphinx_rtd_theme`_:\r\n\r\n.. code:: bash\r\n\r\n $ pip install sphinx_rtd_theme\r\n\r\n\r\nDocs?\r\n~~~~~~~~\r\n\r\n* `Read The Docs (.org) `_\r\n* `Python Hosted (.org) `_\r\n\r\n\r\nMisc.\r\n---------------\r\n\r\n\r\nContact Information\r\n~~~~~~~~~~~~~~~~~~~~~~~~\r\n\r\nThis project is currently hosted on `bitbucket `_, \r\nat `https://bitbucket.org/bmearns/docit `_.\r\nThe primary author is Brian Mearns, whom you can contact through bitbucket at\r\n`https://bitbucket.org/bmearns `_. \r\n\r\n\r\nCopyright and License\r\n~~~~~~~~~~~~~~~~~~~~~~~~~~\r\n\r\n\\ ``docit``\\ is \\ *free software*\\ : you can redistribute it and/or modify\r\nit under the terms of the \\ **GNU General Public License**\\ as published by\r\nthe Free Software Foundation, either version 3 of the License, or\r\n(at your option) any later version. \r\n\r\n\r\n\r\n\\ ``docit``\\ is distributed in the hope that it will be useful,\r\nbut \\ **without any warranty**\\ ; without even the implied warranty of\r\n\\ *merchantability*\\ or \\ *fitness for a particular purpose*\\ . See the\r\nGNU General Public License for more details. \r\n\r\n\r\n\r\nA copy of the GNU General Public License is available in the\r\n\\ ``docit``\\ distribution under the file LICENSE.txt. If you did not\r\nreceive a copy of this file, see\r\n`http://www.gnu.org/licenses/ `_. \r\n\r\n.. _sphinx_rtd_theme: https://github.com/snide/sphinx_rtd_theme\r\n", "description_content_type": null, "docs_url": "https://pythonhosted.org/docit/", "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://bitbucket.org/bmearns/docit", "keywords": null, "license": "LICENSE.txt", "maintainer": null, "maintainer_email": null, "name": "docit", "package_url": "https://pypi.org/project/docit/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/docit/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://bitbucket.org/bmearns/docit" }, "release_url": "https://pypi.org/project/docit/1.0.0.2-r3/", "requires_dist": null, "requires_python": null, "summary": "Simple tools for sphinx autodoc to control whether members are documented or not.", "version": "1.0.0.2-r3" }, "last_serial": 1097258, "releases": { "1.0.0.0-r1": [ { "comment_text": "", "digests": { "md5": "14b55325fe6febacdab8c4f08646a507", "sha256": "47643a28afe760e446f37aa0e5b8778395d33b0b5ec0b8a61b6adb78514272bc" }, "downloads": -1, "filename": "docit-1.0.0.0_r1-py2.7.egg", "has_sig": false, "md5_digest": "14b55325fe6febacdab8c4f08646a507", "packagetype": "bdist_egg", "python_version": "2.7", "requires_python": null, "size": 13548, "upload_time": "2014-05-16T16:59:29", "url": "https://files.pythonhosted.org/packages/25/f9/6bbfca3b0c5a0e1b907772830c82b4261212cc332c6710dfa1f949e44615/docit-1.0.0.0_r1-py2.7.egg" }, { "comment_text": "", "digests": { "md5": "50f9bbf6dda327be095337bf92e89edb", "sha256": "d3f727360407466d9cf3ace1cae04076c98bfcb7c2664a5f7253ba438f337590" }, "downloads": -1, "filename": "docit-1.0.0.0-r1.tar.bz2", "has_sig": false, "md5_digest": "50f9bbf6dda327be095337bf92e89edb", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 26453, "upload_time": "2014-05-16T16:59:17", "url": "https://files.pythonhosted.org/packages/fd/36/a1fafd15d5d01654a2897e35f404032c75e87b186c64bb6173d3b7694223/docit-1.0.0.0-r1.tar.bz2" }, { "comment_text": "", "digests": { "md5": "da3eeba85f911f98106977a4548d7bcb", "sha256": "d044093a20711644f40001fb6584e40cbb2bcbf2cd2f7bbb88a0bb0a4c6685bd" }, "downloads": -1, "filename": "docit-1.0.0.0-r1.tar.gz", "has_sig": false, "md5_digest": "da3eeba85f911f98106977a4548d7bcb", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 29625, "upload_time": "2014-05-16T16:59:19", "url": "https://files.pythonhosted.org/packages/b7/63/d935276a9ce6b534e52ea5f0b423c5cf81e620ba1f14c8e101d960187e31/docit-1.0.0.0-r1.tar.gz" }, { "comment_text": "", "digests": { "md5": "d8a403cf6785f5aa1c5ef833b326669c", "sha256": "c72bc519330882517f0a05742cc4f80407b6bd7e386ce3d15c7a677d009ee15a" }, "downloads": -1, "filename": "docit-1.0.0.0-r1.win32.exe", "has_sig": false, "md5_digest": "d8a403cf6785f5aa1c5ef833b326669c", "packagetype": "bdist_wininst", "python_version": "any", "requires_python": null, "size": 204176, "upload_time": "2014-05-16T16:59:25", "url": "https://files.pythonhosted.org/packages/db/a2/324e5510cbfe54254ddcbb7482294f03f566d13eba25690562136a5fcb22/docit-1.0.0.0-r1.win32.exe" }, { "comment_text": "", "digests": { "md5": "0be7d8cb12f275b9cb5bf0fdf9b63d73", "sha256": "65e36306041b9f2e853de30c1d433c9f13630324a5ceb5ec5d3c4d83753d83dc" }, "downloads": -1, "filename": "docit-1.0.0.0-r1.zip", "has_sig": false, "md5_digest": "0be7d8cb12f275b9cb5bf0fdf9b63d73", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 35611, "upload_time": "2014-05-16T16:59:22", "url": "https://files.pythonhosted.org/packages/5b/db/949dd6dbe9a2653b2998dd17d5d4afaf60e9191b43202f772ebd51eae7da/docit-1.0.0.0-r1.zip" } ], "1.0.0.1-r2": [ { "comment_text": "", "digests": { "md5": "195a4ab0f35294ff2e75abb3aa37eec0", "sha256": "ed1ef201cb87727f7d52fc47dfe5aed8a990bc53796df166c6be1604697d50b0" }, "downloads": -1, "filename": "docit-1.0.0.1_r2-py2.7.egg", "has_sig": false, "md5_digest": "195a4ab0f35294ff2e75abb3aa37eec0", "packagetype": "bdist_egg", "python_version": "2.7", "requires_python": null, "size": 13708, "upload_time": "2014-05-19T14:30:37", "url": "https://files.pythonhosted.org/packages/c7/5a/9327b162bd6368bca314cbee52d465b7e0559f85575774db2837456dcad0/docit-1.0.0.1_r2-py2.7.egg" }, { "comment_text": "", "digests": { "md5": "cc1ff112c1f866b8fba76c3db03c989f", "sha256": "e8b4ff1e051fced7dbad3de8b7c2540fb4c348a90c78810438ba9e4ce67c92c7" }, "downloads": -1, "filename": "docit-1.0.0.1-r2.tar.bz2", "has_sig": false, "md5_digest": "cc1ff112c1f866b8fba76c3db03c989f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 26537, "upload_time": "2014-05-19T14:30:39", "url": "https://files.pythonhosted.org/packages/df/bd/f62bbbe145b96e85857bb77df0cdb7eadbdc9d45cc89778c1898346135d3/docit-1.0.0.1-r2.tar.bz2" }, { "comment_text": "", "digests": { "md5": "a3f839a591b61f46d1b01b703c1fb4e1", "sha256": "709189a3d844fff55fd8840fa7f1a9e6b9455766a06c0567688c7cf06b771267" }, "downloads": -1, "filename": "docit-1.0.0.1-r2.tar.gz", "has_sig": false, "md5_digest": "a3f839a591b61f46d1b01b703c1fb4e1", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 29723, "upload_time": "2014-05-19T14:30:42", "url": "https://files.pythonhosted.org/packages/d7/5e/8f3517619c6221d0a26e6ec024f6c52bba38a573b4f21c708f71d53f1b23/docit-1.0.0.1-r2.tar.gz" }, { "comment_text": "", "digests": { "md5": "b12cb23397b2686fb8da622ec1aa8a35", "sha256": "dd9214ce3f8071946bb8c9965caf8d57ceac384b7ab6303850ff0a4ac6843241" }, "downloads": -1, "filename": "docit-1.0.0.1-r2.win32.exe", "has_sig": false, "md5_digest": "b12cb23397b2686fb8da622ec1aa8a35", "packagetype": "bdist_wininst", "python_version": "any", "requires_python": null, "size": 204255, "upload_time": "2014-05-19T14:30:33", "url": "https://files.pythonhosted.org/packages/fa/d5/07125a25b36df6c61d36392aca720a652b8bc6c1f745c712da81917c3f3d/docit-1.0.0.1-r2.win32.exe" }, { "comment_text": "", "digests": { "md5": "deb14fca9748a666b46ad149b4065786", "sha256": "354ac5c3426b0cce50ceb4c5347aa3b38418258b0d21a4ac0b4e3af382e6275e" }, "downloads": -1, "filename": "docit-1.0.0.1-r2.zip", "has_sig": false, "md5_digest": "deb14fca9748a666b46ad149b4065786", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 35740, "upload_time": "2014-05-19T14:30:46", "url": "https://files.pythonhosted.org/packages/05/ba/1f0b42d12cde637fab820a4135220ae70711262a8917d5aa4dc0bea1ca0d/docit-1.0.0.1-r2.zip" } ], "1.0.0.2-r2": [ { "comment_text": "", "digests": { "md5": "07502bdc7055b3c2af2fdddb8a6cdd8e", "sha256": "882c083472a694d0bd05600f34a536ca3f98115bb080956263122753d47eab20" }, "downloads": -1, "filename": "docit-1.0.0.2_r2-py2.7.egg", "has_sig": false, "md5_digest": "07502bdc7055b3c2af2fdddb8a6cdd8e", "packagetype": "bdist_egg", "python_version": "2.7", "requires_python": null, "size": 13713, "upload_time": "2014-05-19T14:37:01", "url": "https://files.pythonhosted.org/packages/f1/b8/a104c8d1c1bc9906d1fabd70e98a755918c3b940a0cfed0203f1bbc4f747/docit-1.0.0.2_r2-py2.7.egg" }, { "comment_text": "", "digests": { "md5": "4bd2eab92b0c9f4a96411363a0282b82", "sha256": "9364012be2a34153e86c92219d9c5091cc0de08b277deae6af13b2a2de8e82fd" }, "downloads": -1, "filename": "docit-1.0.0.2-r2.tar.bz2", "has_sig": false, "md5_digest": "4bd2eab92b0c9f4a96411363a0282b82", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 26540, "upload_time": "2014-05-19T14:37:03", "url": "https://files.pythonhosted.org/packages/09/e1/6dfa1f025f37143c6cd079c1a0bfa522d59d36f4c58b14104fa5ae433f14/docit-1.0.0.2-r2.tar.bz2" }, { "comment_text": "", "digests": { "md5": "0cd97619615e539a6289293dcf4d5598", "sha256": "2c07b2ef1f1e5812737cf1140bf799dd97b85de528454ecee0e2a7fd2c5f0c7b" }, "downloads": -1, "filename": "docit-1.0.0.2-r2.tar.gz", "has_sig": false, "md5_digest": "0cd97619615e539a6289293dcf4d5598", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 29748, "upload_time": "2014-05-19T14:37:06", "url": "https://files.pythonhosted.org/packages/5e/2d/cf8a491595eb387c406398f86b606079fd233ab33484c26db0124d2f6d24/docit-1.0.0.2-r2.tar.gz" }, { "comment_text": "", "digests": { "md5": "59c7f3b46fbdc9854e3884a772790e60", "sha256": "54ba2b0638fc67aea4852c1630480a47e3748ed2f4efe16305d3186edeae1793" }, "downloads": -1, "filename": "docit-1.0.0.2-r2.win32.exe", "has_sig": false, "md5_digest": "59c7f3b46fbdc9854e3884a772790e60", "packagetype": "bdist_wininst", "python_version": "any", "requires_python": null, "size": 204258, "upload_time": "2014-05-19T14:36:58", "url": "https://files.pythonhosted.org/packages/37/51/126d5ecc0b9027191d2507d26ad7ce2da6cf85729cea16e25dd81f9a6194/docit-1.0.0.2-r2.win32.exe" }, { "comment_text": "", "digests": { "md5": "be9b3c014e7452691524937bc670ff4a", "sha256": "fecf60d4d6ba3d0334827b77b08c3481966056c9b7ef4eb7d74a9e1e1ca31f22" }, "downloads": -1, "filename": "docit-1.0.0.2-r2.zip", "has_sig": false, "md5_digest": "be9b3c014e7452691524937bc670ff4a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 35787, "upload_time": "2014-05-19T14:37:08", "url": "https://files.pythonhosted.org/packages/93/10/8c524120329b21f0d99cb6d28e25109536fdfbb124a154c3b745e758138f/docit-1.0.0.2-r2.zip" } ], "1.0.0.2-r3": [ { "comment_text": "", "digests": { "md5": "fa28948f47ec46165eb48bc124748eaa", "sha256": "8376099dbfdddfad23e64abecf1e5de13e31e43ccd9e405bbdb6230d114dab25" }, "downloads": -1, "filename": "docit-1.0.0.2_r3-py2.7.egg", "has_sig": false, "md5_digest": "fa28948f47ec46165eb48bc124748eaa", "packagetype": "bdist_egg", "python_version": "2.7", "requires_python": null, "size": 13716, "upload_time": "2014-05-19T14:38:52", "url": "https://files.pythonhosted.org/packages/b5/48/be741ebf131ea7250b7cf145cbaa42033e2cd4eab17f33617423c7391d46/docit-1.0.0.2_r3-py2.7.egg" }, { "comment_text": "", "digests": { "md5": "22f9af1ec977b4c93f78735d5209a45e", "sha256": "7064e333cbab2a10468e0aec2f808bbc1cac1ab86e29f68279b539a43636be2a" }, "downloads": -1, "filename": "docit-1.0.0.2-r3.tar.bz2", "has_sig": false, "md5_digest": "22f9af1ec977b4c93f78735d5209a45e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 26586, "upload_time": "2014-05-19T14:38:55", "url": "https://files.pythonhosted.org/packages/87/c0/7d91cd4dfe8e5bbf7953d208edbb35744b9b474dd42fddbcb09442a66a19/docit-1.0.0.2-r3.tar.bz2" }, { "comment_text": "", "digests": { "md5": "1fa2b812b78bef83343d37d4743947e6", "sha256": "2bce65674a261386462a5bf21399e795f7efe41039b1dda8a80d91840b6a9bd0" }, "downloads": -1, "filename": "docit-1.0.0.2-r3.tar.gz", "has_sig": false, "md5_digest": "1fa2b812b78bef83343d37d4743947e6", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 29757, "upload_time": "2014-05-19T14:38:57", "url": "https://files.pythonhosted.org/packages/86/89/cfc771895ea8f00c53b6b6a987a2a935828cda89a9bc7cc7c523eec5b4a0/docit-1.0.0.2-r3.tar.gz" }, { "comment_text": "", "digests": { "md5": "107bbd7467cc75bc4a5f0a173944a9ef", "sha256": "1a6546f0b2da2d55a4da6c2fa85d4cfa40db8e0156ccbd12f1b998114660cae4" }, "downloads": -1, "filename": "docit-1.0.0.2-r3.win32.exe", "has_sig": false, "md5_digest": "107bbd7467cc75bc4a5f0a173944a9ef", "packagetype": "bdist_wininst", "python_version": "any", "requires_python": null, "size": 204260, "upload_time": "2014-05-19T14:38:49", "url": "https://files.pythonhosted.org/packages/9d/77/d30ad28cf980c002d88f0d77199ec0b9b0156d8c49569a0d45e2bc453e47/docit-1.0.0.2-r3.win32.exe" }, { "comment_text": "", "digests": { "md5": "997ef67b2a6f5b21d3c27fcb1a489098", "sha256": "45184387ae122e48ba544c301d986dc8ba452985afd9e5651d1bda5386ac6428" }, "downloads": -1, "filename": "docit-1.0.0.2-r3.zip", "has_sig": false, "md5_digest": "997ef67b2a6f5b21d3c27fcb1a489098", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 35789, "upload_time": "2014-05-19T14:39:00", "url": "https://files.pythonhosted.org/packages/27/36/532975f0c69d41bcd150dbf790c6d6c02f81a3c82ee8ffdf74d5da8a699c/docit-1.0.0.2-r3.zip" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "fa28948f47ec46165eb48bc124748eaa", "sha256": "8376099dbfdddfad23e64abecf1e5de13e31e43ccd9e405bbdb6230d114dab25" }, "downloads": -1, "filename": "docit-1.0.0.2_r3-py2.7.egg", "has_sig": false, "md5_digest": "fa28948f47ec46165eb48bc124748eaa", "packagetype": "bdist_egg", "python_version": "2.7", "requires_python": null, "size": 13716, "upload_time": "2014-05-19T14:38:52", "url": "https://files.pythonhosted.org/packages/b5/48/be741ebf131ea7250b7cf145cbaa42033e2cd4eab17f33617423c7391d46/docit-1.0.0.2_r3-py2.7.egg" }, { "comment_text": "", "digests": { "md5": "22f9af1ec977b4c93f78735d5209a45e", "sha256": "7064e333cbab2a10468e0aec2f808bbc1cac1ab86e29f68279b539a43636be2a" }, "downloads": -1, "filename": "docit-1.0.0.2-r3.tar.bz2", "has_sig": false, "md5_digest": "22f9af1ec977b4c93f78735d5209a45e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 26586, "upload_time": "2014-05-19T14:38:55", "url": "https://files.pythonhosted.org/packages/87/c0/7d91cd4dfe8e5bbf7953d208edbb35744b9b474dd42fddbcb09442a66a19/docit-1.0.0.2-r3.tar.bz2" }, { "comment_text": "", "digests": { "md5": "1fa2b812b78bef83343d37d4743947e6", "sha256": "2bce65674a261386462a5bf21399e795f7efe41039b1dda8a80d91840b6a9bd0" }, "downloads": -1, "filename": "docit-1.0.0.2-r3.tar.gz", "has_sig": false, "md5_digest": "1fa2b812b78bef83343d37d4743947e6", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 29757, "upload_time": "2014-05-19T14:38:57", "url": "https://files.pythonhosted.org/packages/86/89/cfc771895ea8f00c53b6b6a987a2a935828cda89a9bc7cc7c523eec5b4a0/docit-1.0.0.2-r3.tar.gz" }, { "comment_text": "", "digests": { "md5": "107bbd7467cc75bc4a5f0a173944a9ef", "sha256": "1a6546f0b2da2d55a4da6c2fa85d4cfa40db8e0156ccbd12f1b998114660cae4" }, "downloads": -1, "filename": "docit-1.0.0.2-r3.win32.exe", "has_sig": false, "md5_digest": "107bbd7467cc75bc4a5f0a173944a9ef", "packagetype": "bdist_wininst", "python_version": "any", "requires_python": null, "size": 204260, "upload_time": "2014-05-19T14:38:49", "url": "https://files.pythonhosted.org/packages/9d/77/d30ad28cf980c002d88f0d77199ec0b9b0156d8c49569a0d45e2bc453e47/docit-1.0.0.2-r3.win32.exe" }, { "comment_text": "", "digests": { "md5": "997ef67b2a6f5b21d3c27fcb1a489098", "sha256": "45184387ae122e48ba544c301d986dc8ba452985afd9e5651d1bda5386ac6428" }, "downloads": -1, "filename": "docit-1.0.0.2-r3.zip", "has_sig": false, "md5_digest": "997ef67b2a6f5b21d3c27fcb1a489098", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 35789, "upload_time": "2014-05-19T14:39:00", "url": "https://files.pythonhosted.org/packages/27/36/532975f0c69d41bcd150dbf790c6d6c02f81a3c82ee8ffdf74d5da8a699c/docit-1.0.0.2-r3.zip" } ] }