{ "info": { "author": "Dieter Maurer", "author_email": "dieter@handshake.de", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Framework :: Zope2", "Intended Audience :: Developers", "License :: OSI Approved :: BSD License", "Operating System :: OS Independent", "Programming Language :: Python", "Topic :: Documentation" ], "description": "dm.zdoc\n=======\n\nTiny wrapper around ``pydoc`` to make it usable for Zope.\n\nNote: Python versions below 2.6 lack good support for namespace\npackages in ``pydoc``. While Zope itself does not use\nnamespace packages before version 2.12 (which uses Python 2.6),\nimportant Zope applications (such as Plone) do use namespace packages.\nIn these cases, the documentation produced by ``pydoc`` (and\nby extension ``zdoc``) is incomplete.\n\n\nUsage\n=====\n\n``zdoc`` can either be used via the script ``dmzdoc``, via module import\nor integrated in a running Zope instance.\n\nIn the first two cases it might be necessary to set\nthe Zope environment variables ``INSTANCE_HOME``\nand ``SOFTWARE_HOME`` to tell ``zdoc`` where the Zope sources can be found.\n\nUse via ``dmzdoc``\n------------------\n\nThe script ``dmzdoc`` is installed when you have ``setuptools`` installed.\n\nOtherwise, you must install it yourself. It has the following content::\n\n import dm.zdoc; dm.zdoc.cli()\n\n``dmzdoc`` has the exact same options and parameters as ``pydoc``,\ndocumented in pydoc_.\n\nUse via module import\n---------------------\n\nThe module ``dm.zdoc`` defines the same objects as ``pydoc``,\ndocumented in pydoc_.\n\n\n\nIntegrated in a running Zope instance\n-------------------------------------\n\nFor this use, you must install the module in your Zope installation\nand activate its ``configure.zcml`` at Zope startup.\nThis will give the \"Zope Root Folder\" the view ``@@zdoc``\nwhich presents the documentation in the same way as the ``pydoc`` http server.\n\nATTENTION: Exposing the documentation of a Zope instance in this way\nprovides sensible insights and could give hackers valuable clues for\nattacks. Likely, you will install this only in development\ninstances with restricted access.\n\n\nVersion History\n===============\n\n * 2.0 support for the \"integrated in a runnging Zope instance\" use case\n\n * 1.1 works around a bug in either ``zope.interface`` or ``inspect``.\n\n\n.. _pydoc: http://docs.python.org/lib/module-pydoc.html", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "UNKNOWN", "keywords": "pydoc documentation Zope", "license": "BSD (see \"dm/zdoc/LICENSE.txt\", for details)", "maintainer": null, "maintainer_email": null, "name": "dm.zdoc", "package_url": "https://pypi.org/project/dm.zdoc/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/dm.zdoc/", "project_urls": { "Download": "UNKNOWN", "Homepage": "UNKNOWN" }, "release_url": "https://pypi.org/project/dm.zdoc/2.0/", "requires_dist": null, "requires_python": null, "summary": "pydoc based documentation for Zope", "version": "2.0" }, "last_serial": 791260, "releases": { "1.0": [ { "comment_text": "", "digests": { "md5": "3e499f254c2a7f461b4166e54d6e5329", "sha256": "f2bf43d0af1117296a753fc86b0bdd5e1347ed2db25176da5d3acf0970b84424" }, "downloads": -1, "filename": "dm.zdoc-1.0.tar.gz", "has_sig": false, "md5_digest": "3e499f254c2a7f461b4166e54d6e5329", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3266, "upload_time": "2008-01-06T12:55:47", "url": "https://files.pythonhosted.org/packages/68/43/dd905b2f1c87b02c5fc8a328ee5a4414ed2c612d736e698f1dad5331a2fb/dm.zdoc-1.0.tar.gz" } ], "1.1": [ { "comment_text": "", "digests": { "md5": "b2b28f0ae7e9ade3047b562a747f97c4", "sha256": "0a079f4ddba325fef7077a88d7a99b3356f362a2cc9fd84f21935eecf42d3168" }, "downloads": -1, "filename": "dm.zdoc-1.1.tar.gz", "has_sig": false, "md5_digest": "b2b28f0ae7e9ade3047b562a747f97c4", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3551, "upload_time": "2008-01-07T20:59:26", "url": "https://files.pythonhosted.org/packages/b7/b2/4318b8ea05ab0644f0e4b2253528b8f2c06407ac8eaff851b5c852f737fc/dm.zdoc-1.1.tar.gz" } ], "2.0": [ { "comment_text": "", "digests": { "md5": "11b07b59f1b8fd65c4b36cd51fdba72b", "sha256": "7e4ef4e4c5ef934b5dbc2bbaad32f3cdd8424f2c9ecd4cb992c6ce241eb06051" }, "downloads": -1, "filename": "dm.zdoc-2.0.tar.gz", "has_sig": false, "md5_digest": "11b07b59f1b8fd65c4b36cd51fdba72b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4888, "upload_time": "2012-03-31T19:46:05", "url": "https://files.pythonhosted.org/packages/fc/c5/2b50825b65908400ab8184d9f73a6e7d1c0d276b4bba47e0ef1c952eb08b/dm.zdoc-2.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "11b07b59f1b8fd65c4b36cd51fdba72b", "sha256": "7e4ef4e4c5ef934b5dbc2bbaad32f3cdd8424f2c9ecd4cb992c6ce241eb06051" }, "downloads": -1, "filename": "dm.zdoc-2.0.tar.gz", "has_sig": false, "md5_digest": "11b07b59f1b8fd65c4b36cd51fdba72b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4888, "upload_time": "2012-03-31T19:46:05", "url": "https://files.pythonhosted.org/packages/fc/c5/2b50825b65908400ab8184d9f73a6e7d1c0d276b4bba47e0ef1c952eb08b/dm.zdoc-2.0.tar.gz" } ] }