{
    "info": {
        "author": "Elran Shefer",
        "author_email": "elran777@gmail.com",
        "bugtrack_url": null,
        "classifiers": [
            "Intended Audience :: Developers",
            "License :: OSI Approved :: MIT License",
            "Operating System :: MacOS",
            "Operating System :: Microsoft :: Windows",
            "Operating System :: POSIX",
            "Operating System :: Unix",
            "Programming Language :: Python :: 2",
            "Programming Language :: Python :: 2.7",
            "Programming Language :: Python :: 3",
            "Programming Language :: Python :: 3.5",
            "Programming Language :: Python :: 3.6",
            "Programming Language :: Python :: 3.7",
            "Topic :: Software Development :: Testing"
        ],
        "description": "=====\ndocme\n=====\n\n-----\nIntro\n-----\n\n| ``docme`` is a python application, which its goal is to reduce writing redundant rst documentations.\n| it is similar to sphinx builtin ``autodoc`` module, but ``docme`` goal is to create more cleaner look,\n| that ``autodoc`` doesn't provide.\n\n------------\nInstallation\n------------\n\n\nSimply use pip installer:\n\n.. code-block:: bash\n\n    pip install docme\n\nOr download src files from Github/Pypi and write:\n\n.. code-block:: bash\n\n    python setup.py install\n\nfor developers, use:\n\n.. code-block:: bash\n\n    python setup.py develop\n\n--------------\nWhere To Begin\n--------------\n\nSimple Start\n------------\n\nlets say your project's tree is like so:\n\n.. code-block:: bash\n\n    .gitignore\n    src/\n    src/project/\n    src/project/file.py\n\nand you wish to create auto documentation of your project.\n\nsimply use ``docme`` command - which is an entry point which directs to :func:``docme.cli.main`` function:\n\n.. code-block:: bash\n\n    docme src/project doc\n\n| where ``src/project`` is the path to your main project files,\n| and ``doc`` is the directory of docs that will be created.\n\n| The result is that a new folder will be created named ``doc``, and in it all relevant rst files,\n| new tree will look like:\n\n.. code-block:: bash\n\n    .gitignore\n    doc/\n    doc/api_reference/\n    doc/api_reference/project/\n    doc/api_reference/project/file.rst\n    doc/api_reference/project/index.rst\n    doc/api_reference/index.rst\n    doc/index.rst\n    src/\n    src/project/\n    src/project/file.py\n\n\nnow you can simply add ``make`` file and ``conf.py`` for sphinx to compile the doc to html!\n\n.. code-block:: bash\n\n    cd doc\n    make html\n\n\nIncluding External Doc\n----------------------\n\n| lets say you already got some doc to include to the api reference:\n\n.. code-block:: bash\n\n    .gitignore\n    doc/\n    doc/how_to_start/\n    doc/how_to_start/advanced.rst\n    doc/how_to_start/intro.rst\n    doc/how_to_start/index.rst\n    src/\n    src/project/\n    src/project/file.py\n\nyou can include ``how_to_start`` section like so:\n\n.. code-block:: bash\n\n    docme src/project doc --extra-doc how_to_start/index\n\n| pay attention it is exactly the line you need to add to the main ``index.rst``.\n| newly created tree:\n\n.. code-block:: bash\n\n    .gitignore\n    doc/\n    doc/how_to_start/\n    doc/how_to_start/advanced.rst\n    doc/how_to_start/intro.rst\n    doc/how_to_start/index.rst\n    doc/api_reference/\n    doc/api_reference/project/\n    doc/api_reference/project/file.rst\n    doc/api_reference/project/index.rst\n    doc/api_reference/index.rst\n    doc/index.rst\n    src/\n    src/project/\n    src/project/file.py\n\n| In your doc you can reference classes and functions from your api!\n| like so:\n\n::\n\n    :class:`example<path.to.Class>`\n\n\n",
        "description_content_type": "text/x-rst",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "",
        "keywords": "doc",
        "license": "MIT",
        "maintainer": "",
        "maintainer_email": "",
        "name": "docme",
        "package_url": "https://pypi.org/project/docme/",
        "platform": "",
        "project_url": "https://pypi.org/project/docme/",
        "project_urls": null,
        "release_url": "https://pypi.org/project/docme/0.5.0/",
        "requires_dist": [
            "pyyaml"
        ],
        "requires_python": ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*",
        "summary": "Auto documentation generating",
        "version": "0.5.0"
    },
    "last_serial": 4646771,
    "releases": {
        "0.1.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "38b67873c941a3f27c22e60ee8485ef3",
                    "sha256": "558ccfd1388b0be1431f27afb488a43b1aebc7831a20fc17b3ff58f5a0e5fe9f"
                },
                "downloads": -1,
                "filename": "docme-0.1.0-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "38b67873c941a3f27c22e60ee8485ef3",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": "~=2.7.0",
                "size": 5684,
                "upload_time": "2018-12-24T21:57:58",
                "url": "https://files.pythonhosted.org/packages/38/16/3e5f4589f37b5ce87a947980841a42a99af9fb57d9bef8324ac831f95efe/docme-0.1.0-py2.py3-none-any.whl"
            }
        ],
        "0.2.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "5f163b4e2f136d5e355aba780d376173",
                    "sha256": "4103878da6a68002c27dd0411f35e20e5561bddbfd2d0dd4fa3281fd7d371418"
                },
                "downloads": -1,
                "filename": "docme-0.2.0-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "5f163b4e2f136d5e355aba780d376173",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": "~=2.7.0",
                "size": 8227,
                "upload_time": "2018-12-26T22:32:53",
                "url": "https://files.pythonhosted.org/packages/46/f4/8d209550986accd040a0f2985ba60dd9461de07a25fbb9b0e9b7b3a37026/docme-0.2.0-py2.py3-none-any.whl"
            }
        ],
        "0.3.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "0fea8d63f2d39e4a48d68889df823b71",
                    "sha256": "db315cfa111b6e7c4d1af1135dbb03fd3d4b0965015393fe246827ff6d90efda"
                },
                "downloads": -1,
                "filename": "docme-0.3.0-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "0fea8d63f2d39e4a48d68889df823b71",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": "~=2.7.0",
                "size": 8532,
                "upload_time": "2018-12-27T20:51:16",
                "url": "https://files.pythonhosted.org/packages/03/94/924ab83de83e8be9ac8ee7f440831dd919ee924d78ed1c55c65c0d994283/docme-0.3.0-py2.py3-none-any.whl"
            }
        ],
        "0.4.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "265158f612e2db88685e5c62469c2b69",
                    "sha256": "bc8706053aeb765f78974fbe605a6ed27c8171ef47c1972cd1226d51d12fe104"
                },
                "downloads": -1,
                "filename": "docme-0.4.0-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "265158f612e2db88685e5c62469c2b69",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*",
                "size": 16371,
                "upload_time": "2018-12-29T18:14:19",
                "url": "https://files.pythonhosted.org/packages/a4/00/aabde37603a0eb38073eaa75524c9c868edf4f01bcbb7d2c96d048481c8e/docme-0.4.0-py2.py3-none-any.whl"
            }
        ],
        "0.4.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "69836163eef3efeaa6c182218212d753",
                    "sha256": "98c763275e07f2f34e0276bb60e560b53f22f6ade47faa963223d5ece41130b5"
                },
                "downloads": -1,
                "filename": "docme-0.4.1-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "69836163eef3efeaa6c182218212d753",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*",
                "size": 14573,
                "upload_time": "2018-12-29T18:18:20",
                "url": "https://files.pythonhosted.org/packages/76/25/1ae5eda8a3b40f9edc8a1817ecdcff433f08d7c39a29b08b1f20aaa0f1de/docme-0.4.1-py2.py3-none-any.whl"
            }
        ],
        "0.4.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "5743a2e612835a3d57880e98c0e46abb",
                    "sha256": "b2c93271aa03502e68da86821787dc4683341d7ab5ff639f56c6134abcb3e430"
                },
                "downloads": -1,
                "filename": "docme-0.4.2-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "5743a2e612835a3d57880e98c0e46abb",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*",
                "size": 14600,
                "upload_time": "2018-12-29T18:19:21",
                "url": "https://files.pythonhosted.org/packages/b2/04/197438f55967d4fcb2ceed218d4b188627c6167b8fe32344453107aa6adf/docme-0.4.2-py2.py3-none-any.whl"
            }
        ],
        "0.4.3": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "67ee226752fcf1066278db5c91e96b55",
                    "sha256": "458825cd926030e8ab179150465413c5619a537f414cc20bdc96c51e31a07da5"
                },
                "downloads": -1,
                "filename": "docme-0.4.3-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "67ee226752fcf1066278db5c91e96b55",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*",
                "size": 14599,
                "upload_time": "2018-12-29T18:23:57",
                "url": "https://files.pythonhosted.org/packages/a3/21/af727a3a56386544143151581e1c0a659ae8fec5853e1b256dcaf5c55f3a/docme-0.4.3-py2.py3-none-any.whl"
            }
        ],
        "0.5.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "881cefc3326ed2c5dce9288f5f046e99",
                    "sha256": "822b3467d609fe2ae1780fb75ed2ac57440f8fe4eb5650c97f0ebba4d2476398"
                },
                "downloads": -1,
                "filename": "docme-0.5.0-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "881cefc3326ed2c5dce9288f5f046e99",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*",
                "size": 15502,
                "upload_time": "2018-12-30T19:09:25",
                "url": "https://files.pythonhosted.org/packages/a8/ae/c8f6c50140164dafc3648cc8bc8f55ad49e1815ae8230e16b1698fe914e6/docme-0.5.0-py2.py3-none-any.whl"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "881cefc3326ed2c5dce9288f5f046e99",
                "sha256": "822b3467d609fe2ae1780fb75ed2ac57440f8fe4eb5650c97f0ebba4d2476398"
            },
            "downloads": -1,
            "filename": "docme-0.5.0-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "881cefc3326ed2c5dce9288f5f046e99",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*",
            "size": 15502,
            "upload_time": "2018-12-30T19:09:25",
            "url": "https://files.pythonhosted.org/packages/a8/ae/c8f6c50140164dafc3648cc8bc8f55ad49e1815ae8230e16b1698fe914e6/docme-0.5.0-py2.py3-none-any.whl"
        }
    ]
}