{ "info": { "author": "Michael Hudson-Doyle", "author_email": "micahel@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 6 - Mature", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 2 :: Only", "Programming Language :: Python :: Implementation :: CPython", "Programming Language :: Python :: Implementation :: PyPy", "Topic :: Documentation", "Topic :: Software Development :: Documentation" ], "description": "pydoctor\n========\n\n.. image:: https://travis-ci.org/twisted/pydoctor.svg?branch=tox-travis-2\n :target: https://travis-ci.org/twisted/pydoctor\n\n.. image:: https://codecov.io/gh/twisted/pydoctor/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/twisted/pydoctor\n\nThis is 'pydoctor', an API documentation generator that works by\nstatic analysis.\n\nIt was written primarily to replace epydoc for the purposes of the\nTwisted project as epydoc has difficulties with zope.interface. If it\nhappens to work for your code too, that's a nice bonus :)\n\npydoctor puts a fair bit of effort into resolving imports and\ncomputing inheritance hierarchies and, as it aims at documenting\nTwisted, knows about zope.interface's declaration API and can present\ninformation about which classes implement which interface, and vice\nversa.\n\nThe default HTML generator requires Twisted.\n\nThere are some more notes in the doc/ subdirectory.\n\n\nTox development environment\n---------------------------\n\nSince Python 3 is not yet supported, you the case in which your default\ntox runs with Python 3, call the tox as::\n\n python2 -m tox -e pyflakes\n\n\nSphinx Integration\n------------------\n\nHTML generator will also generate a Sphinx objects inventory using the\nfollowing mapping:\n\n* packages, modules -> py:mod:\n* classes -> py:class:\n* functions -> py:func:\n* methods -> py:meth:\n* attributes -> py:attr:\n\nConfigure Sphinx intersphinx extension:\n\n intersphinx_mapping = {\n 'pydoctor': ('http://domain.tld/api', None),\n }\n\nUse external references::\n\n :py:func:`External API `\n\n :py:mod:`pydoctor:pydoctor`\n :py:mod:`pydoctor:pydoctor.model`\n :py:func:`pydoctor:pydoctor.driver.getparser`\n :py:class:`pydoctor:pydoctor.model.Documentable`\n :py:meth:`pydoctor:pydoctor.model.Documentable.reparent`\n :py:attr:`pydoctor:pydoctor.model.Documentable.kind`\n\nIt can link to external API documentation using Sphinx objects inventory using\nthe following cumulative configuration option::\n\n --intersphinx=http://sphinx-doc.org/objects.inv\n\n\nReleasing a new package\n-----------------------\n\nReleasing a new version is done via Travis-CI.\nFirst commit the version update to master and wait for tests to pass.\nCreate a tag on local branch and then push it::\n\n git tag 1.2.3\n git push --tags\n", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://github.com/twisted/pydoctor", "keywords": "", "license": "MIT/X11", "maintainer": "", "maintainer_email": "", "name": "pydoctor", "package_url": "https://pypi.org/project/pydoctor/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/pydoctor/", "project_urls": { "Homepage": "http://github.com/twisted/pydoctor" }, "release_url": "https://pypi.org/project/pydoctor/16.3.0/", "requires_dist": null, "requires_python": "", "summary": "API doc generator.", "version": "16.3.0" }, "last_serial": 2340539, "releases": { "0.4": [ { "comment_text": "", "digests": { "md5": "b7564e12b5d35d4cb529a2c220b25d3a", "sha256": "7c7ca5f7a5daa7999065752f1293b8b1f319fded3750d0c01da30060f1638b69" }, "downloads": -1, "filename": "pydoctor-0.4.tar.gz", "has_sig": true, "md5_digest": "b7564e12b5d35d4cb529a2c220b25d3a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 81064, "upload_time": "2012-11-14T23:41:35", "url": "https://files.pythonhosted.org/packages/1a/66/596a6fe6f862b604a42fe3b0f3366078d5c88d37cc9b1da8fdfa322c1172/pydoctor-0.4.tar.gz" } ], "0.4a1": [], "0.5": [ { "comment_text": "", "digests": { "md5": "76652703e59f8ee4e767f33d3510ba81", "sha256": "f55d7e7847274974a3f37ac06d41215ed29ebbe5b0cf075ee17148763e8d2f12" }, "downloads": -1, "filename": "pydoctor-0.5.tar.gz", "has_sig": true, "md5_digest": "76652703e59f8ee4e767f33d3510ba81", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 83632, "upload_time": "2014-02-04T22:08:23", "url": "https://files.pythonhosted.org/packages/21/07/ae514d9496be0f68e38c94deff75bafb281e33e140de3c635768d8627056/pydoctor-0.5.tar.gz" } ], "0.5b1": [ { "comment_text": "", "digests": { "md5": "c4fb33672f37624116cc7a0606f74f28", "sha256": "f1eab7f8e0b5dfe0d7b66dff481f2ba057af3cfc51bbf1606f19d17205ccfb49" }, "downloads": -1, "filename": "pydoctor-0.5b1.tar.gz", "has_sig": false, "md5_digest": "c4fb33672f37624116cc7a0606f74f28", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 81573, "upload_time": "2013-01-30T01:29:46", "url": "https://files.pythonhosted.org/packages/11/d9/27f6375b0b4b240127d02f78b5f991205d397e3755d75ca7d64c760c0a4b/pydoctor-0.5b1.tar.gz" } ], "0.5b2": [ { "comment_text": "", "digests": { "md5": "7beaa325a9250975403c4ec9606d295a", "sha256": "abaadc7857114e61a0cc7d76a4ba55bb5b89cfceac4bd835867a638f6efac55d" }, "downloads": -1, "filename": "pydoctor-0.5b2.tar.gz", "has_sig": true, "md5_digest": "7beaa325a9250975403c4ec9606d295a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 83012, "upload_time": "2014-01-05T21:35:11", "url": "https://files.pythonhosted.org/packages/a1/ea/e411968aca9a026df147ec01c4cfbae0c8359e8d3e5d5c6aa31423ad9788/pydoctor-0.5b2.tar.gz" } ], "0.6b1": [ { "comment_text": "", "digests": { "md5": "2725b45375c433e558dce6ad127d1148", "sha256": "7306d86287fe7f4fd2c4b98d48f96eb28c7f6956e79b950eb9c78e3a2b66c8ba" }, "downloads": -1, "filename": "pydoctor-0.6b1.tar.gz", "has_sig": true, "md5_digest": "2725b45375c433e558dce6ad127d1148", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 102251, "upload_time": "2015-01-07T01:49:40", "url": "https://files.pythonhosted.org/packages/d8/c2/faa465399783b33d83abc1a6a076f8f3b5129eff03d5f61d326e434ce092/pydoctor-0.6b1.tar.gz" } ], "0.6b2": [ { "comment_text": "", "digests": { "md5": "a61a1e0fb72ea6bde3e78e932784c2e9", "sha256": "f36a89789561bf512b0dac466b85a2914bb1b6139e0ede9b57d535312a69fe5b" }, "downloads": -1, "filename": "pydoctor-0.6b2.tar.gz", "has_sig": true, "md5_digest": "a61a1e0fb72ea6bde3e78e932784c2e9", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 102285, "upload_time": "2015-01-07T21:34:43", "url": "https://files.pythonhosted.org/packages/ea/e5/244389959adcb97ba3d5923a32f00cab2f0e1ba87a235837e6d56998613e/pydoctor-0.6b2.tar.gz" } ], "15.0.0": [ { "comment_text": "", "digests": { "md5": "0bc4ad6a50b5bbf93dc9a478039d65f1", "sha256": "3732e74f6ff78db5d69d3d55fabffc6c69d0b56a0ca609871239a24676f8227b" }, "downloads": -1, "filename": "pydoctor-15.0.0.tar.gz", "has_sig": false, "md5_digest": "0bc4ad6a50b5bbf93dc9a478039d65f1", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 84117, "upload_time": "2015-05-21T04:26:16", "url": "https://files.pythonhosted.org/packages/9f/5b/45114be66dbe0a222acbf6aee14b9fbbe9d38bd53f9ee1c6582f3c898074/pydoctor-15.0.0.tar.gz" } ], "15.1.0": [ { "comment_text": "", "digests": { "md5": "b6be0a074e28f60fa21b4662194acfa3", "sha256": "5fd353e0409fbcf4e99640b3749057539040392bad7d66b51ffa51067be561a4" }, "downloads": -1, "filename": "pydoctor-15.1.0-py2-none-any.whl", "has_sig": false, "md5_digest": "b6be0a074e28f60fa21b4662194acfa3", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 166773, "upload_time": "2015-12-14T08:48:17", "url": "https://files.pythonhosted.org/packages/9b/b3/fdca4e37392aa8e139b5e060f15d2ba56fca79875ae91dce5b5826c37797/pydoctor-15.1.0-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "cb83419a76583d57898f8597f160151f", "sha256": "4d7f639650d6726ea1b883263439f9c98fe9c0aef1e68352609d43ac8f423895" }, "downloads": -1, "filename": "pydoctor-15.1.0.tar.gz", "has_sig": false, "md5_digest": "cb83419a76583d57898f8597f160151f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 105809, "upload_time": "2015-12-14T08:48:28", "url": "https://files.pythonhosted.org/packages/21/f0/3fb862039d5c9ecdc051fb2e0ef9bd348549fc857a454214127d711b2c3a/pydoctor-15.1.0.tar.gz" } ], "16.0.0": [ { "comment_text": "", "digests": { "md5": "a54be9229829e7018bc532c81e2b4a8f", "sha256": "595a6a33db38249b440ed9f6dce0efe130ae34df4f2e50db0d19c8a983c5f88b" }, "downloads": -1, "filename": "pydoctor-16.0.0.tar.gz", "has_sig": false, "md5_digest": "a54be9229829e7018bc532c81e2b4a8f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 78297, "upload_time": "2016-07-07T10:46:02", "url": "https://files.pythonhosted.org/packages/51/5f/c7af3e18dec2fc116cfa87013ac39c8276469076510a761247a11234ef0b/pydoctor-16.0.0.tar.gz" } ], "16.1.0": [ { "comment_text": "", "digests": { "md5": "e0fab572637517e0090fa7d24a777f17", "sha256": "8a56523ac37d1565a36110817ac108c025bb916ecb8b163e35ede63a2b3f6ca7" }, "downloads": -1, "filename": "pydoctor-16.1.0.tar.gz", "has_sig": false, "md5_digest": "e0fab572637517e0090fa7d24a777f17", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 94403, "upload_time": "2016-07-12T01:56:41", "url": "https://files.pythonhosted.org/packages/d3/d2/1ea64e121c88c326e05168f43c8c956dd2a63db2b7bf23adcd1eca463a5a/pydoctor-16.1.0.tar.gz" } ], "16.1.1": [ { "comment_text": "", "digests": { "md5": "223e474a82f2625d38cc94475878743c", "sha256": "02707e139e7291c29973ae43c0cf12330920db60407a93e841f762ea739553d9" }, "downloads": -1, "filename": "pydoctor-16.1.1.tar.gz", "has_sig": false, "md5_digest": "223e474a82f2625d38cc94475878743c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 94617, "upload_time": "2016-07-19T22:58:19", "url": "https://files.pythonhosted.org/packages/53/e6/ad0430b06fc1eba4c71e8f863515d1ab9aa83530ad0cd808640b57da9419/pydoctor-16.1.1.tar.gz" } ], "16.2.0": [ { "comment_text": "", "digests": { "md5": "b5f4ebeb86ed08a84393c4982453e467", "sha256": "6276696bb693cb9c0c77224a4fb890a2cf5a2a63b186308ac7ca05aa0d8914c7" }, "downloads": -1, "filename": "pydoctor-16.2.0.tar.gz", "has_sig": false, "md5_digest": "b5f4ebeb86ed08a84393c4982453e467", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 94621, "upload_time": "2016-07-21T15:15:21", "url": "https://files.pythonhosted.org/packages/80/b5/f18622fc7fce75896736a6d2c6f2db978ab314c15d32500d9d3b0932cf0f/pydoctor-16.2.0.tar.gz" } ], "16.2.1": [ { "comment_text": "", "digests": { "md5": "f08ceaa51b2e1c2264f1c6f41d696906", "sha256": "e6e1dee81d19d9058c0206064cfa15f6eeedaded74354cfc12f0449e70a733cb" }, "downloads": -1, "filename": "pydoctor-16.2.1.tar.gz", "has_sig": false, "md5_digest": "f08ceaa51b2e1c2264f1c6f41d696906", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 94694, "upload_time": "2016-08-10T08:27:39", "url": "https://files.pythonhosted.org/packages/b9/c5/ea3393d1663deadbec4d4a99e03be2fa3bd32b93ad01078ffe2cf9ec6367/pydoctor-16.2.1.tar.gz" } ], "16.3.0": [ { "comment_text": "", "digests": { "md5": "1e94e1dfc8fc6f76fedc847bf082a860", "sha256": "e1f400d95b4fbdfbc2e5837ef7d8b8d8461c1801b706b58858e38c954201953e" }, "downloads": -1, "filename": "pydoctor-16.3.0.tar.gz", "has_sig": false, "md5_digest": "1e94e1dfc8fc6f76fedc847bf082a860", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 94811, "upload_time": "2016-09-13T16:27:50", "url": "https://files.pythonhosted.org/packages/ca/48/2d43d52b9ed3869ab62b98baefc2bd10e526f2e80a8d65ab44c56213560e/pydoctor-16.3.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "1e94e1dfc8fc6f76fedc847bf082a860", "sha256": "e1f400d95b4fbdfbc2e5837ef7d8b8d8461c1801b706b58858e38c954201953e" }, "downloads": -1, "filename": "pydoctor-16.3.0.tar.gz", "has_sig": false, "md5_digest": "1e94e1dfc8fc6f76fedc847bf082a860", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 94811, "upload_time": "2016-09-13T16:27:50", "url": "https://files.pythonhosted.org/packages/ca/48/2d43d52b9ed3869ab62b98baefc2bd10e526f2e80a8d65ab44c56213560e/pydoctor-16.3.0.tar.gz" } ] }