{
    "info": {
        "author": "Andreas Paepcke",
        "author_email": "paepcke@cs.stanford.edu",
        "bugtrack_url": null,
        "classifiers": [],
        "description": "# pdoc_prep: Add sphinx-like function doc specs to pdoc #\n\nPrepares Python files that use sphinx-like parameter and return  specifications for input to the pdoc documentation tool (https://pypi.org/project/pdoc/). \n\n## Motivation:\n\nThe pdoc HTML output does not recognize function/method parameter and return specifications in doc strings as special. So,\n\n       :param foo: controls whether bar is set to None\n       :type foo: int\n       :return True for success, else False\n       :rtype bool\n\n\nwill show up literally. If a module to be documentated is  instead preprocessed using this script, then the pdoc documentation will look like this:\n```\n          foo (int): controls whether bar is set to None\n          returns True for success, else False\n          return type: bool\n```\n\nThe keywords, such as **returns**, and parameters, such as **foo (int)** will be bold faced.\n\n**Note:** whether '**:**' is used to introduce a specification, or '**@**' is controlled from a command line option. See main section below.\n\n## Usage\n\n    shell> pdoc_run.py --html-dir docs src/pdoc_prep/pdoc_prep.py\n\nThis command may be run from the project root, from within the evolving docs directory, or in the package directory. Obviously, the paths need to be adjusted accordingly.\n\n## Notes\n\n**Note 1:**\nYou may see:\n\n    DeprecationWarning: the imp module is deprecated in favour of importlib; see the module's documentation for alternative uses\n    import imp\n\nThis warning occurs in pdoc, which is not modified by this preprocessor. To suppress the warning, you can define an environment variable:\n\n    export PYTHONWARNINGS=ignore\n\nin the shell where you are working.\n\n**Note2:**\nIt would be more sensible to include this functionality in the pdoc HTML production code itself. Alas, not enough time.\n\n\n\n",
        "description_content_type": "text/markdown",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/paepcke/pdoc_prep",
        "keywords": "pdoc,python documentation",
        "license": "BSD",
        "maintainer": "",
        "maintainer_email": "",
        "name": "pdoc-prep",
        "package_url": "https://pypi.org/project/pdoc-prep/",
        "platform": "",
        "project_url": "https://pypi.org/project/pdoc-prep/",
        "project_urls": {
            "Homepage": "https://github.com/paepcke/pdoc_prep"
        },
        "release_url": "https://pypi.org/project/pdoc-prep/0.0.4/",
        "requires_dist": [
            "pdoc (>=0.3.2)"
        ],
        "requires_python": "",
        "summary": "Add processing of sphinx-like docstring specs to pdoc via preprocessor.",
        "version": "0.0.4"
    },
    "last_serial": 4639301,
    "releases": {
        "0.0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "b01c5188738399699eb7568658b390ce",
                    "sha256": "89677bbe968b3ad14f2afa32cc83e61ea546f4672cfec66589de7d6bd57dba3d"
                },
                "downloads": -1,
                "filename": "pdoc_prep-0.0.1-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "b01c5188738399699eb7568658b390ce",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 1968,
                "upload_time": "2018-12-27T17:50:51",
                "url": "https://files.pythonhosted.org/packages/69/f0/1c8710928320e915c8d9868c4e4ea8a374165f16568bef71de21a6115776/pdoc_prep-0.0.1-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "121124c398c6486fddb656847ef1d1bd",
                    "sha256": "f01cf798a88bb5a1829cb39efe0eec65c894c9b6aa0b71f6f27c770eb7aae46b"
                },
                "downloads": -1,
                "filename": "pdoc_prep-0.0.1.tar.gz",
                "has_sig": false,
                "md5_digest": "121124c398c6486fddb656847ef1d1bd",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 2050,
                "upload_time": "2018-12-27T18:01:56",
                "url": "https://files.pythonhosted.org/packages/4e/36/a7cf960dd40e1f3b6b284df8c0f675898aa89321ccdb255aac4301d9ed48/pdoc_prep-0.0.1.tar.gz"
            }
        ],
        "0.0.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "36d641f87665a750279bebe314137373",
                    "sha256": "eb54f709e39a92015e53a9c8c49608f03e64033333bd8a2164b729080567e6c0"
                },
                "downloads": -1,
                "filename": "pdoc_prep-0.0.2-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "36d641f87665a750279bebe314137373",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 1970,
                "upload_time": "2018-12-27T18:01:55",
                "url": "https://files.pythonhosted.org/packages/a8/76/2bf74c31c3004d2777b07ef10def88160133b687bd444437d3946c14ef57/pdoc_prep-0.0.2-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "09c5544ac583fddfa55ae0852ec93cde",
                    "sha256": "647d26304854f73d6a2104820653bd51367187ae2503fab7626da199ffefead0"
                },
                "downloads": -1,
                "filename": "pdoc_prep-0.0.2.tar.gz",
                "has_sig": false,
                "md5_digest": "09c5544ac583fddfa55ae0852ec93cde",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 2053,
                "upload_time": "2018-12-27T18:01:57",
                "url": "https://files.pythonhosted.org/packages/05/a2/41e143b303651f5fef7064f852dfd9963dbe9b00ada0e412563bde622b15/pdoc_prep-0.0.2.tar.gz"
            }
        ],
        "0.0.3": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "3e4d85e6a5b361686fa8582de49afc65",
                    "sha256": "d36476966a48e4793b7dd2f44309ea9fd23f92e255e8c1bb98a8bd1a7e56605b"
                },
                "downloads": -1,
                "filename": "pdoc_prep-0.0.3-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "3e4d85e6a5b361686fa8582de49afc65",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 1995,
                "upload_time": "2018-12-27T18:18:47",
                "url": "https://files.pythonhosted.org/packages/2c/fd/0e3212710e12aa8c85bea06d2677a74b8071b4452f2dd815ecb39a8b7908/pdoc_prep-0.0.3-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "897c3d6c8e30926f92901205b8c5774f",
                    "sha256": "a20293a182424ffe8873956cdc78d265c64fee0becc3f31381cb3365518fc2d1"
                },
                "downloads": -1,
                "filename": "pdoc_prep-0.0.3.tar.gz",
                "has_sig": false,
                "md5_digest": "897c3d6c8e30926f92901205b8c5774f",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 2065,
                "upload_time": "2018-12-27T18:18:48",
                "url": "https://files.pythonhosted.org/packages/21/5a/da95e286237d94fdd7136c2514f5ee295a56097cfe41f5a4d0aa2b3cc7bc/pdoc_prep-0.0.3.tar.gz"
            }
        ],
        "0.0.4": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "a3143fd4f2d5133c2d31c2cc0dc881e2",
                    "sha256": "fb3f01a174e5bf254f46f127487b7be1aca77aa54e6c488e0d1f41904c80713f"
                },
                "downloads": -1,
                "filename": "pdoc_prep-0.0.4-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "a3143fd4f2d5133c2d31c2cc0dc881e2",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 16465,
                "upload_time": "2018-12-27T23:42:06",
                "url": "https://files.pythonhosted.org/packages/ee/04/462f34d89f03f12641f76d718fa7ad15af38f36fcc20776ca4ec15c40c3a/pdoc_prep-0.0.4-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "40a327ae046ce151b864eb22152b0216",
                    "sha256": "27318826a66e6bbd0cec44917c9222e365586a2274cb9005dafd374f58936ae3"
                },
                "downloads": -1,
                "filename": "pdoc_prep-0.0.4.tar.gz",
                "has_sig": false,
                "md5_digest": "40a327ae046ce151b864eb22152b0216",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 60897,
                "upload_time": "2018-12-27T23:42:08",
                "url": "https://files.pythonhosted.org/packages/62/82/51579f0ca8908ef9d5c22dba35087d1fd3bc7874d318768c095473a7b33b/pdoc_prep-0.0.4.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "a3143fd4f2d5133c2d31c2cc0dc881e2",
                "sha256": "fb3f01a174e5bf254f46f127487b7be1aca77aa54e6c488e0d1f41904c80713f"
            },
            "downloads": -1,
            "filename": "pdoc_prep-0.0.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "a3143fd4f2d5133c2d31c2cc0dc881e2",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 16465,
            "upload_time": "2018-12-27T23:42:06",
            "url": "https://files.pythonhosted.org/packages/ee/04/462f34d89f03f12641f76d718fa7ad15af38f36fcc20776ca4ec15c40c3a/pdoc_prep-0.0.4-py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "40a327ae046ce151b864eb22152b0216",
                "sha256": "27318826a66e6bbd0cec44917c9222e365586a2274cb9005dafd374f58936ae3"
            },
            "downloads": -1,
            "filename": "pdoc_prep-0.0.4.tar.gz",
            "has_sig": false,
            "md5_digest": "40a327ae046ce151b864eb22152b0216",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 60897,
            "upload_time": "2018-12-27T23:42:08",
            "url": "https://files.pythonhosted.org/packages/62/82/51579f0ca8908ef9d5c22dba35087d1fd3bc7874d318768c095473a7b33b/pdoc_prep-0.0.4.tar.gz"
        }
    ]
}