{
    "info": {
        "author": "Michael Jones",
        "author_email": "http://github.com/michaeljones",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 4 - Beta",
            "Environment :: Plugins",
            "Intended Audience :: Developers",
            "License :: OSI Approved :: BSD License",
            "Operating System :: OS Independent",
            "Operating System :: POSIX",
            "Programming Language :: Python",
            "Topic :: Documentation"
        ],
        "description": "Sphinx to GitHub\n================\n\nATTENTION!\n----------\n\nThis project is designed to help you get around the github-pages Jekyll\nbehaviour of ignoring top level directories starting with an underscore.\n\nThis is solved in a much neater way by creating a ``.nojekyll`` in the root\nof you github-pages which will disable Jekyll as described `here\n<https://github.com/blog/572-bypassing-jekyll-on-github-pages>`__ and `here\n<http://pages.github.com/>`__.\n\nThis makes this project largely useless! Thank you to `acdha\n<https://github.com/acdha>`__ for making me aware of this.\n\nWhat?\n-----\n\nA Python script for preparing the html output of the Sphinx documentation\nsystem for github pages.\n\nIt renames any top level folders which start with an underscore and edits any\nreferences to them within the html files.\n\nWhy?\n----\n\nGitHub processes the incoming html with Jekyll which believes top level folders\nstarting with an underscore are special and does not let their content be accessible\nto the server. This is incompatible with Sphinx which uses underscores at the\nstart of folder names for static content.\n\nUsage\n-----\n\nThe ``sphinxtogithub.py`` script can be run on the command line or used as a\nSphinx extension.\n\nExtension\n~~~~~~~~~\n\nPlace the script on the ``PYTHONPATH`` and add ``sphinxtogithub`` to the\nextensions list in the ``conf.py`` file in your Sphinx project::\n\n    extensions = [ \"sphinxtogithub\" ]\n\nAdditionally there are three config variables you can use to control the\nextension. The first enables/disables the extension, the second enables verbose\noutput and the third determines the encoding which is used to read & write\nfiles. The first two are ``True`` by default and the third is set to ``utf-8``::\n\n    sphinx_to_github = True\n    sphinx_to_github_verbose = True\n    sphinx_to_github_encoding = \"utf-8\"\n\nCommand Line\n~~~~~~~~~~~~\n\nRun the script with the path to the ``html`` output directory as the first\nargument. There is a ``--verbose`` flag for basic output.\n\nFurther Information\n-------------------\n\nInstall from GitHub\n~~~~~~~~~~~~~~~~~~~\n\nIt should be possible to install this tool directly from github using pip::\n\n    pip install -e git+git://github.com/michaeljones/sphinx-to-github.git#egg=sphinx-to-github\n\nThanks to `winhamwr <http://github.com/winhamwr>`_'s work.\n\nRequirements\n~~~~~~~~~~~~\n\nThe script uses ``/usr/bin/env`` and ``python``.\n\nRunning Tests\n~~~~~~~~~~~~~\n\nUnit tests can be run using the setuptools ``test`` target. eg::\n\n    $ python setup.py test\n\nAlternatives\n~~~~~~~~~~~~\n\n`dinoboff <http://github.com/dinoboff>`_'s project\n`github-tools <http://github.com/dinoboff/github-tools>`_ provides similar\nfunctionality combined with a much more comprehensive set of tools for helping\nyou to manage Python based projects on github.\n\nCredits\n-------\n\nThank you to:\n\n* `mikejs <http://github.com/mikejs>`_\n* `certik <http://github.com/certik>`_\n* `davvid <http://github.com/davvid>`_\n* `winhamwr <http://github.com/winhamwr>`_\n* `johnpaulett <http://github.com/johnpaulett>`_\n* `boothead <http://github.com/boothead>`_\n* `kennethreitz <https://github.com/kennethreitz>`_\n* `acdha <https://github.com/acdha>`_\n* `garbados <http://github.com/garbados>`_\n\nFor their contributions, which are beginning to outweigh mine, to Georg Brandl\nfor `Sphinx <http://sphinx.pocoo.org/>`_ and the github crew for the pages\nfunctionality.",
        "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/michaeljones/sphinx-to-github",
        "keywords": null,
        "license": "BSD",
        "maintainer": null,
        "maintainer_email": null,
        "name": "sphinxtogithub",
        "package_url": "https://pypi.org/project/sphinxtogithub/",
        "platform": "any",
        "project_url": "https://pypi.org/project/sphinxtogithub/",
        "project_urls": {
            "Download": "UNKNOWN",
            "Homepage": "http://github.com/michaeljones/sphinx-to-github"
        },
        "release_url": "https://pypi.org/project/sphinxtogithub/1.1.0/",
        "requires_dist": null,
        "requires_python": null,
        "summary": "Script for preparing the html output of the Sphinx documentation system for\ngithub pages.",
        "version": "1.1.0"
    },
    "last_serial": 903649,
    "releases": {
        "1.0.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "675891b2505e7ea79d331d35ffce3a5f",
                    "sha256": "71e191b38defcfcff4acd918190a6322d8b7374fe84b97b6bc17d74c550c5759"
                },
                "downloads": -1,
                "filename": "sphinxtogithub-1.0.0.tar.gz",
                "has_sig": false,
                "md5_digest": "675891b2505e7ea79d331d35ffce3a5f",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 9872,
                "upload_time": "2010-11-11T19:17:05",
                "url": "https://files.pythonhosted.org/packages/42/fe/9112d752a0329c74faf8e00afd1ef84dcab395ff70e66d711dd06358e7a1/sphinxtogithub-1.0.0.tar.gz"
            }
        ],
        "1.1.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "ed77afb540f41c2d86267096142539ae",
                    "sha256": "15222b1ea55f83dfdf1e09a76d4ef1b9273a2590b73a5a16c4bff972894eae4e"
                },
                "downloads": -1,
                "filename": "sphinxtogithub-1.1.0.tar.gz",
                "has_sig": false,
                "md5_digest": "ed77afb540f41c2d86267096142539ae",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 11103,
                "upload_time": "2013-10-26T00:39:25",
                "url": "https://files.pythonhosted.org/packages/bb/26/47f00ce30c9e91ae5d8e9c9dcd7907a46d4e5f87c2e2485472d33c453f90/sphinxtogithub-1.1.0.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "ed77afb540f41c2d86267096142539ae",
                "sha256": "15222b1ea55f83dfdf1e09a76d4ef1b9273a2590b73a5a16c4bff972894eae4e"
            },
            "downloads": -1,
            "filename": "sphinxtogithub-1.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "ed77afb540f41c2d86267096142539ae",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 11103,
            "upload_time": "2013-10-26T00:39:25",
            "url": "https://files.pythonhosted.org/packages/bb/26/47f00ce30c9e91ae5d8e9c9dcd7907a46d4e5f87c2e2485472d33c453f90/sphinxtogithub-1.1.0.tar.gz"
        }
    ]
}