{
    "info": {
        "author": "Stephen McDonald",
        "author_email": "stephen.mc@gmail.com",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 5 - Production/Stable",
            "Environment :: Console",
            "Intended Audience :: Developers",
            "License :: OSI Approved :: BSD License",
            "Operating System :: OS Independent",
            "Programming Language :: Python",
            "Programming Language :: Python :: 2.6",
            "Programming Language :: Python :: 2.7",
            "Programming Language :: Python :: 3",
            "Programming Language :: Python :: 3.3",
            "Topic :: Documentation",
            "Topic :: Software Development :: Documentation",
            "Topic :: Utilities"
        ],
        "description": "Created by `Stephen McDonald <http://twitter.com/stephen_mcd>`_\n\nIntroduction\n============\n\nDo you have smaller Python projects that only need a README file\nfor documentation? Want to host your README on `Read The Docs`_?\n\nsphinx-me is a `BSD licensed`_ tool that will create a `Sphinx`_\ndocumentation shell for your project and include the README file\nas the documentation index. It handles extracting the required meta\ndata such as the project name, author and version from your project\nfor use in your Sphinx docs.\n\nOnce you use sphinx-me to build your Sphinx docs, you can then\nadd your project to the Read The Docs site and have your project's\nREADME hosted with an attractive Sphinx documentation theme.\n\n.. note::\n\n    Your README file should be in a `reStructuredText`_ compatible\n    format.\n\nInstallation\n============\n\nThe easiest way to install sphinx-me is directly from `PyPI`_ using\n`pip`_ or `setuptools`_ by running the respective command below::\n\n    $ pip install -U sphinx-me\n\nor::\n\n    $ easy_install -U sphinx-me\n\nOtherwise you can download sphinx-me and install it directly\nfrom source::\n\n    $ python setup.py install\n\nRunning\n=======\n\nsphinx-me will be installed as a system-wide script that can be run from\nthe command line while in your project's root directory::\n\n    $ sphinx-me\n\nWhen run in your project's directory, it will create a ``docs`` directory\nwith two files, the Sphinx ``conf.py`` module, and an ``index.rst`` file\nwhich will include your project's README.\n\nThe ``conf.py`` module calls a setup function from sphinx-me that sets up\nthe minimum required settings for your Sphinx docs.\n\n  * ``project`` - the directory name of your project is used.\n  * ``version`` - retrieved from the ``version`` arg of your\n    ``setup.py`` script, or your package's ``__version__`` attribute.\n  * ``copyright`` - retrieved from the ``author`` arg of your\n    ``setup.py`` script, or your package's ``__author__`` attribute.\n\nRunning this process will also perform an initial ``sphinx-build``\ninside your project's ``docs/build`` directory. Subsequent builds\nafter making changes to your README can be performed by running\nsphinx-me again, or by using the regular ``sphinx-build`` command.\n\nHosting on Read The Docs\n========================\n\nWhen hosting your sphinx-me generated docs on `Read The Docs`_, you\nmust ensure you check the **Use virtualenv** option and specify\n``sphinx-me`` as a requirement in either your ``setup.py`` script,\nor in a `pip requirements file`_ that you'll need to also specify in\nthe **Requirements file** field for your project on Read The Docs.\n\n.. _`Read The Docs`: http://readthedocs.org/\n.. _`BSD licensed`: http://www.linfo.org/bsdlicense.html\n.. _`Sphinx`: http://sphinx.pocoo.org/\n.. _`reStructuredText`: http://docutils.sourceforge.net/rst.html\n.. _`PyPI`: http://pypi.python.org/\n.. _`setuptools`: http://pypi.python.org/pypi/setuptools\n.. _`pip`: http://www.pip-installer.org/\n.. _`pip requirements file`: http://www.pip-installer.org/en/latest/requirement-format.html",
        "description_content_type": null,
        "docs_url": null,
        "download_url": "UNKNOWN",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "http://github.com/stephenmcd/sphinx-me/",
        "keywords": null,
        "license": "BSD",
        "maintainer": null,
        "maintainer_email": null,
        "name": "sphinx-me",
        "package_url": "https://pypi.org/project/sphinx-me/",
        "platform": "UNKNOWN",
        "project_url": "https://pypi.org/project/sphinx-me/",
        "project_urls": {
            "Download": "UNKNOWN",
            "Homepage": "http://github.com/stephenmcd/sphinx-me/"
        },
        "release_url": "https://pypi.org/project/sphinx-me/0.3/",
        "requires_dist": null,
        "requires_python": null,
        "summary": "Wraps your README-only projects in a dynamic Sphinx shell for hosting on http://readthedocs.org",
        "version": "0.3"
    },
    "last_serial": 1177968,
    "releases": {
        "0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "5fc57c104a44159411c4a44db23f9344",
                    "sha256": "cc0dfff4b3cfea68b53357de22c9887226bf4aa4025d03cf4755d8f6f7d320e4"
                },
                "downloads": -1,
                "filename": "sphinx-me-0.1.tar.gz",
                "has_sig": false,
                "md5_digest": "5fc57c104a44159411c4a44db23f9344",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 4903,
                "upload_time": "2011-09-04T13:29:50",
                "url": "https://files.pythonhosted.org/packages/5e/20/07c3ab78e9a2e066df16d6efd78828591389bb73d55edc5792ae8774b5d6/sphinx-me-0.1.tar.gz"
            }
        ],
        "0.1.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "8f1a3752eac8da368b58fad78878eff4",
                    "sha256": "b8cf768d739efb62e0a855411e4e288a97f8c16d8e59d7ca0c3b5119d7ec33a1"
                },
                "downloads": -1,
                "filename": "sphinx-me-0.1.1.tar.gz",
                "has_sig": false,
                "md5_digest": "8f1a3752eac8da368b58fad78878eff4",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 5024,
                "upload_time": "2011-09-07T21:14:44",
                "url": "https://files.pythonhosted.org/packages/19/b7/beb61b83aa98ea06ecca596d0a5ddfc1cc50604d4f96e9b6db405d1a4230/sphinx-me-0.1.1.tar.gz"
            }
        ],
        "0.1.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "650a92b4fa795cc7a12ae47ff45b4068",
                    "sha256": "bd2cb091ed306c1e46c4302e1531958077d16819159e5287b36450739ccbca36"
                },
                "downloads": -1,
                "filename": "sphinx-me-0.1.2.tar.gz",
                "has_sig": false,
                "md5_digest": "650a92b4fa795cc7a12ae47ff45b4068",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 5013,
                "upload_time": "2011-09-07T21:41:29",
                "url": "https://files.pythonhosted.org/packages/7e/e0/29249d6d4d0a1cdd22c3c2fe1620228e579e8e7bbeef69795ef6b086e62a/sphinx-me-0.1.2.tar.gz"
            }
        ],
        "0.2.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "d833c9021c8a92caeecd1469721d5a82",
                    "sha256": "7678b852be2c53ae7076d1ccc0cf2f58c9baf0e2998bf143a4730207c37a7dc8"
                },
                "downloads": -1,
                "filename": "sphinx-me-0.2.0.tar.gz",
                "has_sig": false,
                "md5_digest": "d833c9021c8a92caeecd1469721d5a82",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 5385,
                "upload_time": "2013-08-28T11:03:24",
                "url": "https://files.pythonhosted.org/packages/88/de/efbd33b279277ea3d4d9f6d455cb76dfb1054d4861fb64c24a7f01a56f4b/sphinx-me-0.2.0.tar.gz"
            }
        ],
        "0.2.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "2553a4dec6f93a940bc09694fbc2cdcc",
                    "sha256": "bbac20df97df5bf40e6131f9fcaa7d940a8c0cdee441e40401205fffb998db4d"
                },
                "downloads": -1,
                "filename": "sphinx-me-0.2.1.tar.gz",
                "has_sig": false,
                "md5_digest": "2553a4dec6f93a940bc09694fbc2cdcc",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 5459,
                "upload_time": "2013-08-28T20:30:39",
                "url": "https://files.pythonhosted.org/packages/f2/49/4a18b7350c231c48577640df33a9e942fbe25d3b3c32bd64b5cc9afd3f58/sphinx-me-0.2.1.tar.gz"
            }
        ],
        "0.3": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "e7b4bff5817fd5c53063d529e62d9a75",
                    "sha256": "2c67a6bbf9d60631a84b687f0bafbfe2cb16e2663deee28ce03d5f07c7d89807"
                },
                "downloads": -1,
                "filename": "sphinx_me-0.3-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "e7b4bff5817fd5c53063d529e62d9a75",
                "packagetype": "bdist_wheel",
                "python_version": "2.7",
                "requires_python": null,
                "size": 7528,
                "upload_time": "2014-08-03T01:33:18",
                "url": "https://files.pythonhosted.org/packages/d0/54/19bc2492a652450bad1faa1de5f4d722bd6965ab2ad5f2c5f3ef9304a930/sphinx_me-0.3-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "a0b11069d808a6bc4a8e533abff7bc02",
                    "sha256": "98bef823a4053ca1ccbbe2322bd855a3c5e98797c50bcfeeb630fe11c47d5f1a"
                },
                "downloads": -1,
                "filename": "sphinx-me-0.3.tar.gz",
                "has_sig": false,
                "md5_digest": "a0b11069d808a6bc4a8e533abff7bc02",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 5682,
                "upload_time": "2014-08-03T01:33:13",
                "url": "https://files.pythonhosted.org/packages/15/05/fa421fa08ab98342b71371117af7197ff130ef6dc7d7646c60a91e9d7eeb/sphinx-me-0.3.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "e7b4bff5817fd5c53063d529e62d9a75",
                "sha256": "2c67a6bbf9d60631a84b687f0bafbfe2cb16e2663deee28ce03d5f07c7d89807"
            },
            "downloads": -1,
            "filename": "sphinx_me-0.3-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "e7b4bff5817fd5c53063d529e62d9a75",
            "packagetype": "bdist_wheel",
            "python_version": "2.7",
            "requires_python": null,
            "size": 7528,
            "upload_time": "2014-08-03T01:33:18",
            "url": "https://files.pythonhosted.org/packages/d0/54/19bc2492a652450bad1faa1de5f4d722bd6965ab2ad5f2c5f3ef9304a930/sphinx_me-0.3-py2.py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "a0b11069d808a6bc4a8e533abff7bc02",
                "sha256": "98bef823a4053ca1ccbbe2322bd855a3c5e98797c50bcfeeb630fe11c47d5f1a"
            },
            "downloads": -1,
            "filename": "sphinx-me-0.3.tar.gz",
            "has_sig": false,
            "md5_digest": "a0b11069d808a6bc4a8e533abff7bc02",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 5682,
            "upload_time": "2014-08-03T01:33:13",
            "url": "https://files.pythonhosted.org/packages/15/05/fa421fa08ab98342b71371117af7197ff130ef6dc7d7646c60a91e9d7eeb/sphinx-me-0.3.tar.gz"
        }
    ]
}