{ "info": { "author": "Andrew Mleczko", "author_email": "andrew@mleczko.net", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Framework :: Plone", "Framework :: Zope2", "Framework :: Zope3", "Intended Audience :: Developers", "License :: OSI Approved :: Zope Public License", "Natural Language :: English", "Operating System :: OS Independent", "Programming Language :: Python" ], "description": "z3c.recipe.epydoc\r\n====================\r\n\r\nIntroduction\r\n------------\r\n\r\nThis buildout recipe generates epydoc documentation for you project\r\n\r\nUsage Instructions\r\n------------------\r\n\r\nLet's say you have a package called ezineserver. In the buildout.cfg file of\r\nyour package, add a ``docs`` section\r\nthat looks like this::\r\n\r\n [docs]\r\n recipe = z3c.recipe.epydoc\r\n eggs =\r\n z3c.recipe.epydoc\r\n ezineserver\r\n doc = ezineserver\r\n\r\nBe sure to include it in the parts, as in::\r\n\r\n [buildout]\r\n develop = .\r\n parts = docs\r\n\r\nNow you can rerun buildout. The recipe will have created an\r\nexecutable script in the bin directory called ``docs``.\r\n\r\nThis script will run the epydoc documentation generation tool on your\r\nsource code.\r\n\r\nTo generate documentation simply run ``docs`` script::\r\n\r\n $ ./bin/docs\r\n\r\nThis generates all the documentation for you and placed it in the\r\nparts directory. You can then open it up in firefox and take a look::\r\n\r\n $ firefox parts/docs/index.html\r\n\r\nAnd that's it!\r\n\r\n\r\nSpecify additional options\r\n--------------------------\r\n\r\nIt's also possible to pass additional epydoc options to the ``docs`` script (for\r\na list of all available options, run the script with the ``--help`` option).\r\n\r\nYou can do this from two different ways:\r\n\r\n* you can pass options directly to the script::\r\n\r\n $ ./bin/docs --no-frames --include-log\r\n\r\n* or you can use the ``defaults`` entry to the ``docs`` section::\r\n\r\n [docs]\r\n recipe = z3c.recipe.epydoc\r\n eggs =\r\n z3c.recipe.epydoc\r\n ezineserver\r\n doc = ezineserver\r\n defaults = ['no-frames', '--include-log']\r\n\r\nThis allows you to create a script with the same options as if you had\r\nspecified them on the command line.\r\n\r\nIf not set, the ``defaults`` entry will default to the value ``['-v',\r\n'--debug']``.\r\n\r\n\r\n=======\r\nCHANGES\r\n=======\r\n\r\n0.0.3 (2009-03-10)\r\n------------------\r\n- Add default cli arguments option in buildout.cfg - thanks to Jonathan Ballet\r\n\r\n0.0.2 (2008-07-09)\r\n------------------\r\n- Pass sys.argv to bin/docs (you can pass additional epydoc options do script)\r\n\r\n0.0.1 (2008-07-08)\r\n------------------\r\n\r\n- Initial release.", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://pypi.python.org/pypi/z3c.recipe.epydoc/", "keywords": "", "license": "ZPL 2.1", "maintainer": "", "maintainer_email": "", "name": "z3c.recipe.epydoc", "package_url": "https://pypi.org/project/z3c.recipe.epydoc/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/z3c.recipe.epydoc/", "project_urls": { "Homepage": "http://pypi.python.org/pypi/z3c.recipe.epydoc/" }, "release_url": "https://pypi.org/project/z3c.recipe.epydoc/0.0.3/", "requires_dist": null, "requires_python": null, "summary": "Use EpyDoc to build documentation for python modules", "version": "0.0.3" }, "last_serial": 802076, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "a84298f038aa15c6943f09cb355dea51", "sha256": "3abd450d46bad2fb3ddba72689f87dfc6f506e9ad99b1b6c483ed77f61f0eda7" }, "downloads": -1, "filename": "z3c.recipe.epydoc-0.0.1-py2.4.egg", "has_sig": false, "md5_digest": "a84298f038aa15c6943f09cb355dea51", "packagetype": "bdist_egg", "python_version": "2.4", "requires_python": null, "size": 5781, "upload_time": "2008-07-08T19:45:25", "url": "https://files.pythonhosted.org/packages/83/1e/5b0868a8c44c6cdec5bc8221ba443c68bee4e544d07fe315f0c01962d7a4/z3c.recipe.epydoc-0.0.1-py2.4.egg" }, { "comment_text": "", "digests": { "md5": "a5d378feebaac308946db59d9e8760c6", "sha256": "3a6fe8f498b6981cc0bad0e0d0e5e34d16a0c265264054b93e4f080c87fa6784" }, "downloads": -1, "filename": "z3c.recipe.epydoc-0.0.1.tar.gz", "has_sig": false, "md5_digest": "a5d378feebaac308946db59d9e8760c6", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4011, "upload_time": "2008-07-08T19:45:25", "url": "https://files.pythonhosted.org/packages/2e/ae/5e0a60ca0bce1f4d7390706898335596cd2f28417ae9af3fbf47d1a6a5e2/z3c.recipe.epydoc-0.0.1.tar.gz" } ], "0.0.2": [ { "comment_text": "", "digests": { "md5": "b5ecfdeb2df5b84dda1afe50e533da75", "sha256": "3afe8f300955261ea00f4f20cd1b3d6b485a71c1504e9c7eefe6611972c9fc84" }, "downloads": -1, "filename": "z3c.recipe.epydoc-0.0.2-py2.4.egg", "has_sig": false, "md5_digest": "b5ecfdeb2df5b84dda1afe50e533da75", "packagetype": "bdist_egg", "python_version": "2.4", "requires_python": null, "size": 6099, "upload_time": "2008-07-09T07:32:04", "url": "https://files.pythonhosted.org/packages/36/4d/8320d77de7a3b80f52ea253b1bee185811d30bb752f9b99395892a18f8ee/z3c.recipe.epydoc-0.0.2-py2.4.egg" }, { "comment_text": "", "digests": { "md5": "e8a2dffbd234b73ec7cc9b5c8b508a16", "sha256": "cd09d1e8f8c1e3c2b42c7a7ef0a874b964a248ce551b2e0545313c73bf985b17" }, "downloads": -1, "filename": "z3c.recipe.epydoc-0.0.2.tar.gz", "has_sig": false, "md5_digest": "e8a2dffbd234b73ec7cc9b5c8b508a16", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4299, "upload_time": "2008-07-09T07:32:04", "url": "https://files.pythonhosted.org/packages/ad/7d/83d3f97e7cdca2d20e900c4ad14b72118a508203ccef7f4f2494796f9cc4/z3c.recipe.epydoc-0.0.2.tar.gz" } ], "0.0.3": [ { "comment_text": "", "digests": { "md5": "0187876c3cc801a7b2e169beab53ab34", "sha256": "1866cf52c52e647edb866e7b216760493932f38ec16799819ba603d63d43290b" }, "downloads": -1, "filename": "z3c.recipe.epydoc-0.0.3-py2.4.egg", "has_sig": false, "md5_digest": "0187876c3cc801a7b2e169beab53ab34", "packagetype": "bdist_egg", "python_version": "2.4", "requires_python": null, "size": 6767, "upload_time": "2009-03-10T18:39:08", "url": "https://files.pythonhosted.org/packages/06/09/e953930b526e6141628abf7a05721b6d95f4cbbcc1983ba8ad98aa1a4645/z3c.recipe.epydoc-0.0.3-py2.4.egg" }, { "comment_text": "", "digests": { "md5": "2be321de66110e48b720d70c206bf95f", "sha256": "36a4fa948370f010f8ee6ff35efe14990c7e312e51e3491eacfa38a2ce090cce" }, "downloads": -1, "filename": "z3c.recipe.epydoc-0.0.3.tar.gz", "has_sig": false, "md5_digest": "2be321de66110e48b720d70c206bf95f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4418, "upload_time": "2009-03-10T18:39:09", "url": "https://files.pythonhosted.org/packages/b5/26/b017409d794785806f0e8abeb1ff48ba704fe86b2ae3026b8a063f97be8b/z3c.recipe.epydoc-0.0.3.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "0187876c3cc801a7b2e169beab53ab34", "sha256": "1866cf52c52e647edb866e7b216760493932f38ec16799819ba603d63d43290b" }, "downloads": -1, "filename": "z3c.recipe.epydoc-0.0.3-py2.4.egg", "has_sig": false, "md5_digest": "0187876c3cc801a7b2e169beab53ab34", "packagetype": "bdist_egg", "python_version": "2.4", "requires_python": null, "size": 6767, "upload_time": "2009-03-10T18:39:08", "url": "https://files.pythonhosted.org/packages/06/09/e953930b526e6141628abf7a05721b6d95f4cbbcc1983ba8ad98aa1a4645/z3c.recipe.epydoc-0.0.3-py2.4.egg" }, { "comment_text": "", "digests": { "md5": "2be321de66110e48b720d70c206bf95f", "sha256": "36a4fa948370f010f8ee6ff35efe14990c7e312e51e3491eacfa38a2ce090cce" }, "downloads": -1, "filename": "z3c.recipe.epydoc-0.0.3.tar.gz", "has_sig": false, "md5_digest": "2be321de66110e48b720d70c206bf95f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4418, "upload_time": "2009-03-10T18:39:09", "url": "https://files.pythonhosted.org/packages/b5/26/b017409d794785806f0e8abeb1ff48ba704fe86b2ae3026b8a063f97be8b/z3c.recipe.epydoc-0.0.3.tar.gz" } ] }