{
    "info": {
        "author": "Mateusz 'novo' Klos",
        "author_email": "novopl@gmail.com",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 2 - Pre-Alpha",
            "Intended Audience :: Developers",
            "License :: OSI Approved :: MIT License",
            "Programming Language :: Python",
            "Topic :: Utilities"
        ],
        "description": ".. image:: https://circleci.com/gh/novopl/sphinx-refdoc.svg?style=shield&circle-token=6e5a5984421c7a4ec1de8efbe6e9ff10e6610e36\n    :target: https://circleci.com/gh/novopl/sphinx-refdoc/tree/master\n\nAbout\n=====\n\n**sphinx-refdoc** is a python reference documentation generator for Sphinx.\n\n.. readme_inclusion_marker\n\nInstallation\n============\n\n.. code-block:: shell\n\n    $ pip install sphinx-refdoc\n\n\nUsage\n=====\n\n.. code-block:: shell\n\n    $ sphinx-refdoc -i <src_pkg_1> -i <src_pkg_2> -o <out_dir>\n\n``sphinx-refdoc`` will parse you're source tree passed as the first parameter.\nIt will then generate a stub for sphinx reference documentation for that source.\nIt auto-generates all required files (one per module) and creates a navigation\nbased on the package structure of the source code.\n\nIt then saves it into the directory passed as the second argument. This will\nusually be a subdirectory of the sphinx documentation directory. You can then\neasily include the generated docs with you existing documentation by pointing\nto the `<out_dir>/index.rst`.  Lets say you have a following directory\nstructure::\n\n    docs/\n    \u251c\u2500\u2500 ref/\n    \u2514\u2500\u2500 index.rst\n\nwhere ``docs/ref`` is the directory containing the generated reference docs\n(2nd argument of ``sphinx-refdoc`` invocation) and index.rst is the\ndocumentation main index file (conf.py points to it). Then if you want to\ninclude the reference documentation, you just need to add ``ref/index`` to the\ntoctree. For example:\n\n.. code-block:: rst\n\n    .. toctree::\n\n        my_topic_1\n        my_topic_2\n        docs/ref\n\n\nContributing\n============\n\nSetting up development repo\n---------------------------\n\n.. code-block:: shell\n\n    $ git clone git@github.com:novopl/sphinx-refdoc.git\n    $ cd sphinx-refdoc\n    $ virtualenv env\n    $ source ./env/bin/activate\n    $ pip install -r requirements.txt -r ops/devrequirements.txt\n",
        "description_content_type": "",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/novopl/sphinx-refdoc",
        "keywords": "",
        "license": "MIT",
        "maintainer": "",
        "maintainer_email": "",
        "name": "sphinx-refdoc",
        "package_url": "https://pypi.org/project/sphinx-refdoc/",
        "platform": "",
        "project_url": "https://pypi.org/project/sphinx-refdoc/",
        "project_urls": {
            "Homepage": "https://github.com/novopl/sphinx-refdoc"
        },
        "release_url": "https://pypi.org/project/sphinx-refdoc/0.3.1/",
        "requires_dist": null,
        "requires_python": "",
        "summary": "Reference documentation generator for sphinx",
        "version": "0.3.1"
    },
    "last_serial": 4348281,
    "releases": {
        "0.0.10": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "af6761b4e029f46242525cc388e1c7db",
                    "sha256": "8fc94e768c933b0856901a08a250af7345cb29f9e9c579737bcabfb9ea739948"
                },
                "downloads": -1,
                "filename": "sphinx-refdoc-0.0.10.tar.gz",
                "has_sig": false,
                "md5_digest": "af6761b4e029f46242525cc388e1c7db",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 5670,
                "upload_time": "2017-02-05T00:23:59",
                "url": "https://files.pythonhosted.org/packages/6b/d8/72b0480b3bd21c758c3d2b0eb840440bc6606ff37d5895b6c8b07c855ba8/sphinx-refdoc-0.0.10.tar.gz"
            }
        ],
        "0.0.11": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "ee604fb58134543b32cb8f3ab96bd708",
                    "sha256": "f530990f7f6343ab7ad092c79437724bf7563749d664fa45c85e81d2ad01fd0b"
                },
                "downloads": -1,
                "filename": "sphinx-refdoc-0.0.11.tar.gz",
                "has_sig": false,
                "md5_digest": "ee604fb58134543b32cb8f3ab96bd708",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 6212,
                "upload_time": "2017-02-05T14:08:32",
                "url": "https://files.pythonhosted.org/packages/a1/07/49045ddec47aaa27e3a4e8e3edd7d54b55e92c605d4c9cd233190e581048/sphinx-refdoc-0.0.11.tar.gz"
            }
        ],
        "0.0.12": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "2aa2c7b1461df5fb5233688410961129",
                    "sha256": "9252cbc82c987e3cce6676ecb625c0c62c089969c76e2e7de5c3873ad587a0f4"
                },
                "downloads": -1,
                "filename": "sphinx-refdoc-0.0.12.tar.gz",
                "has_sig": false,
                "md5_digest": "2aa2c7b1461df5fb5233688410961129",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 6221,
                "upload_time": "2017-02-05T14:10:23",
                "url": "https://files.pythonhosted.org/packages/fa/7a/f9ad89acfaf00571cf2d7504314fded1b2e188a1eee6363384b9db19fbaa/sphinx-refdoc-0.0.12.tar.gz"
            }
        ],
        "0.0.14": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "359aead86c3fa49be04ff5e9e5cede0d",
                    "sha256": "0541356f3bbc16fdd2b1d07e33c62bdbf8d4b50286b7664900e8300594724491"
                },
                "downloads": -1,
                "filename": "sphinx-refdoc-0.0.14.tar.gz",
                "has_sig": false,
                "md5_digest": "359aead86c3fa49be04ff5e9e5cede0d",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 6452,
                "upload_time": "2017-02-05T17:54:19",
                "url": "https://files.pythonhosted.org/packages/66/1f/57b2ecb9be0beda3aff103606cbda3717bf9393ddd6d27b311d47a7a9923/sphinx-refdoc-0.0.14.tar.gz"
            }
        ],
        "0.0.15": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "381bce5db1244ba1fe7b50341cd49d74",
                    "sha256": "2764981721f361a106d5f4b4f4bafa3c25bd87625346dd9289f1941b3b9a4b89"
                },
                "downloads": -1,
                "filename": "sphinx-refdoc-0.0.15.tar.gz",
                "has_sig": false,
                "md5_digest": "381bce5db1244ba1fe7b50341cd49d74",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 7257,
                "upload_time": "2017-10-08T11:17:27",
                "url": "https://files.pythonhosted.org/packages/4c/55/fbb243525b207d935175786c26dbba6a4058c75229a872fb6b12203ae708/sphinx-refdoc-0.0.15.tar.gz"
            }
        ],
        "0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "18809dc5bca6c839c1a2a772fc7a5aa4",
                    "sha256": "1025d110405c063b6de60b85fd7d38236bb14764b7f5e3d4a59e3cf3b7988bc7"
                },
                "downloads": -1,
                "filename": "sphinx-refdoc-0.1.tar.gz",
                "has_sig": false,
                "md5_digest": "18809dc5bca6c839c1a2a772fc7a5aa4",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 8102,
                "upload_time": "2017-10-08T23:06:29",
                "url": "https://files.pythonhosted.org/packages/41/63/906b8fcb1f173d698404653ebb16755b2072b2ef34ededc6d759b776488e/sphinx-refdoc-0.1.tar.gz"
            }
        ],
        "0.1.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "6ef909aaeb7ffe3b7a51c3293849adae",
                    "sha256": "f05b8396b1284a1b7a9e607646dbd46e43cdc5c978eb900989e22d3f0ba0a131"
                },
                "downloads": -1,
                "filename": "sphinx-refdoc-0.1.1.tar.gz",
                "has_sig": false,
                "md5_digest": "6ef909aaeb7ffe3b7a51c3293849adae",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 8138,
                "upload_time": "2017-10-09T11:40:02",
                "url": "https://files.pythonhosted.org/packages/1b/f6/6a2a0fd143a5ca88f3c97acc095360aa44472056170bba30dbe0ce1008bf/sphinx-refdoc-0.1.1.tar.gz"
            }
        ],
        "0.1.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "3c3c6e4eddbaaa0a9346959cf28d945e",
                    "sha256": "18159bb3e0da6efabf09bdd4669fd0c3710cee843dec6926a4b254007b7ffc53"
                },
                "downloads": -1,
                "filename": "sphinx-refdoc-0.1.2.tar.gz",
                "has_sig": false,
                "md5_digest": "3c3c6e4eddbaaa0a9346959cf28d945e",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 8131,
                "upload_time": "2017-10-09T12:02:00",
                "url": "https://files.pythonhosted.org/packages/ef/85/f0c53abbbe519dbc0da90a3eb5adefd1fa4bbc19f0ccd72acdb9f6afa1ac/sphinx-refdoc-0.1.2.tar.gz"
            }
        ],
        "0.1.3": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "69b9fb3278a035e9adb16733da4c0d61",
                    "sha256": "ec0c873714ed9fe44442fcfb6dde912eede3e7b036fa568a8a3dc3c643f2183a"
                },
                "downloads": -1,
                "filename": "sphinx-refdoc-0.1.3.tar.gz",
                "has_sig": false,
                "md5_digest": "69b9fb3278a035e9adb16733da4c0d61",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 7227,
                "upload_time": "2018-01-12T04:43:50",
                "url": "https://files.pythonhosted.org/packages/29/89/510edfe2d3c431e68ba00b912cd27a0b74531ce9e877539ad2190ab40bab/sphinx-refdoc-0.1.3.tar.gz"
            }
        ],
        "0.1.4": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "1a43785ad81ee1dfcdeb9b4b7a1eba88",
                    "sha256": "6ea1892331bb804f59544bfea90c2fafcc7e2e62f090e4b96424ca10fcd8da7a"
                },
                "downloads": -1,
                "filename": "sphinx-refdoc-0.1.4.tar.gz",
                "has_sig": false,
                "md5_digest": "1a43785ad81ee1dfcdeb9b4b7a1eba88",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 7340,
                "upload_time": "2018-07-24T19:05:25",
                "url": "https://files.pythonhosted.org/packages/fd/36/87d8ae325dcb1572f7eae446290f0cd0274704ffce3d8e7303e62ee96678/sphinx-refdoc-0.1.4.tar.gz"
            }
        ],
        "0.1.5": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "a3b98a7998bb0fa7354ef152b34037af",
                    "sha256": "d6bd0977492266e70ad9242e40a069eba89465b7d1198e406081049c4b71252d"
                },
                "downloads": -1,
                "filename": "sphinx-refdoc-0.1.5.tar.gz",
                "has_sig": false,
                "md5_digest": "a3b98a7998bb0fa7354ef152b34037af",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 7388,
                "upload_time": "2018-08-27T20:41:59",
                "url": "https://files.pythonhosted.org/packages/59/9f/6f11f099876f5c5759fd6ee5033e454662feba9dc315500687c4cc1e2eb5/sphinx-refdoc-0.1.5.tar.gz"
            }
        ],
        "0.1.6": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "592ed07a372591f39705476fe42a6a68",
                    "sha256": "c56891cc9758d6d9664cd1a8b265fa8278aeea48ea3e8be5de674aa8397e82d2"
                },
                "downloads": -1,
                "filename": "sphinx-refdoc-0.1.6.tar.gz",
                "has_sig": false,
                "md5_digest": "592ed07a372591f39705476fe42a6a68",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 7426,
                "upload_time": "2018-08-28T12:50:30",
                "url": "https://files.pythonhosted.org/packages/04/6a/d8870f152f926594d9a279da1b58fe74d4c50f31125a4f3996a1b3cd3254/sphinx-refdoc-0.1.6.tar.gz"
            }
        ],
        "0.1.7": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "5ba36fb97a46ed17df91e9bcb3c61664",
                    "sha256": "7b14797d34f3820cd46349d3016a6652e0897fdd36707d3e00dcaafcb2866826"
                },
                "downloads": -1,
                "filename": "sphinx-refdoc-0.1.7.tar.gz",
                "has_sig": false,
                "md5_digest": "5ba36fb97a46ed17df91e9bcb3c61664",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 8244,
                "upload_time": "2018-08-28T13:04:42",
                "url": "https://files.pythonhosted.org/packages/f5/1c/fdea158adef35d6616d79451e7e1b38a1b7929c2184c1bd03b90640689bf/sphinx-refdoc-0.1.7.tar.gz"
            }
        ],
        "0.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "926f7260ab73210093af5c654e719012",
                    "sha256": "fee674efd0ceba725d9bf7660385555500fe154ef19f116dba6f1887555a6bc8"
                },
                "downloads": -1,
                "filename": "sphinx-refdoc-0.2.tar.gz",
                "has_sig": false,
                "md5_digest": "926f7260ab73210093af5c654e719012",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 7623,
                "upload_time": "2018-10-06T21:34:57",
                "url": "https://files.pythonhosted.org/packages/7b/8c/802248928aff9faaf74b85fd1d168e010089f00aae7f47d987be1d3849f2/sphinx-refdoc-0.2.tar.gz"
            }
        ],
        "0.3": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "d651ce73df42fb04b9fe94c683650cd2",
                    "sha256": "57cd82e7e00834e9428e8901020e71fc09ae46a32632f1ecf89b4257aa8ec251"
                },
                "downloads": -1,
                "filename": "sphinx-refdoc-0.3.tar.gz",
                "has_sig": false,
                "md5_digest": "d651ce73df42fb04b9fe94c683650cd2",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 8155,
                "upload_time": "2018-10-06T23:47:49",
                "url": "https://files.pythonhosted.org/packages/c4/8a/1df7c4c511e8e7f5af041058e64db2f0dc4ae42974707ae5731f274ae2b5/sphinx-refdoc-0.3.tar.gz"
            }
        ],
        "0.3.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "ef26af40e989989add49a68ccb7bb258",
                    "sha256": "4f629412ae4f95c8074da77c6666370c61e29a4c19f168febe4ab6b0ba66edb1"
                },
                "downloads": -1,
                "filename": "sphinx-refdoc-0.3.1.tar.gz",
                "has_sig": false,
                "md5_digest": "ef26af40e989989add49a68ccb7bb258",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 8169,
                "upload_time": "2018-10-07T00:07:51",
                "url": "https://files.pythonhosted.org/packages/4a/6b/fefe7e05fdd7771b73f0acf2bad923272aeb3d8b1a2445119ea5fbe0bde3/sphinx-refdoc-0.3.1.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "ef26af40e989989add49a68ccb7bb258",
                "sha256": "4f629412ae4f95c8074da77c6666370c61e29a4c19f168febe4ab6b0ba66edb1"
            },
            "downloads": -1,
            "filename": "sphinx-refdoc-0.3.1.tar.gz",
            "has_sig": false,
            "md5_digest": "ef26af40e989989add49a68ccb7bb258",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 8169,
            "upload_time": "2018-10-07T00:07:51",
            "url": "https://files.pythonhosted.org/packages/4a/6b/fefe7e05fdd7771b73f0acf2bad923272aeb3d8b1a2445119ea5fbe0bde3/sphinx-refdoc-0.3.1.tar.gz"
        }
    ]
}