{ "info": { "author": "Simon Kaeser", "author_email": "skaeser@gmail.com", "bugtrack_url": null, "classifiers": [ "Programming Language :: Python" ], "description": "Introduction\n============\n\n``horae.sphinx.grok`` is an extension for the `Sphinx `_\ndocumentation generator. It provides two new autodoc directives ``autogrok`` and\n``autogrokfunction``. By using those directives instead of the stock ``autoclass``\nand ``autofunction`` ones additional grok specific information is given about\nthe class or function.\n\nIf the ``autogrok`` directive is as an example used on the following class definition::\n\n class ExampleAdapter(grok.Adapter):\n \"\"\"\n An adapter demonstrating the autogrok directive\n \"\"\"\n grok.context(IAdaptee)\n grok.implements(ISomeFunctionality)\n grok.name('example')\n\nThe reStructuredText output of the docstring would look like this::\n\n An adapter demonstrating the autogrok directive\n \n :context:\n :class:`IAdaptee`\n :implements:\n :class:`ISomeFunctionality`\n :name:\n example\n\nThe ``autogrokfunction`` is doing the same for functions::\n\n @grok.adapter(IAdaptee, name=\"example\")\n @grok.implementer(ISomeFunctionality)\n def example_adapter_factory(context):\n \"\"\"\n An adapter factory demonstrating the autogrokfunction directive\n \"\"\"\n return ExampleAdapter(context)\n\nWhich would result in::\n\n An adapter factory demonstrating the autogrokfunction directive\n \n :context:\n :class:`IAdaptee`\n :implements:\n :class:`ISomeFunctionality`\n :name:\n example\n\nChangelog\n=========\n\n1.0a1 (2012-01-16)\n------------------\n\n- Initial release", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "UNKNOWN", "keywords": "", "license": "GPL", "maintainer": null, "maintainer_email": null, "name": "horae.sphinx.grok", "package_url": "https://pypi.org/project/horae.sphinx.grok/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/horae.sphinx.grok/", "project_urls": { "Download": "UNKNOWN", "Homepage": "UNKNOWN" }, "release_url": "https://pypi.org/project/horae.sphinx.grok/1.0a1/", "requires_dist": null, "requires_python": null, "summary": "Provides grok specific autodoc directives for sphinx", "version": "1.0a1" }, "last_serial": 793001, "releases": { "1.0a1": [ { "comment_text": "", "digests": { "md5": "03bd953bc1efac9ea1468d8cb8162806", "sha256": "478f8746221944dd9919ee7a802630f1f928e6f5fde4d87f3f0049d0383fd898" }, "downloads": -1, "filename": "horae.sphinx.grok-1.0a1.tar.gz", "has_sig": false, "md5_digest": "03bd953bc1efac9ea1468d8cb8162806", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3132, "upload_time": "2012-01-16T12:05:06", "url": "https://files.pythonhosted.org/packages/f8/aa/9cd02266c6e97e49af6cb68e71658dbbae4fbfca8195aaecf4389c842c24/horae.sphinx.grok-1.0a1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "03bd953bc1efac9ea1468d8cb8162806", "sha256": "478f8746221944dd9919ee7a802630f1f928e6f5fde4d87f3f0049d0383fd898" }, "downloads": -1, "filename": "horae.sphinx.grok-1.0a1.tar.gz", "has_sig": false, "md5_digest": "03bd953bc1efac9ea1468d8cb8162806", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3132, "upload_time": "2012-01-16T12:05:06", "url": "https://files.pythonhosted.org/packages/f8/aa/9cd02266c6e97e49af6cb68e71658dbbae4fbfca8195aaecf4389c842c24/horae.sphinx.grok-1.0a1.tar.gz" } ] }