{
    "info": {
        "author": "Jonathan Sick, originally Dave Snider",
        "author_email": "jsick@lsst.org",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 3 - Alpha",
            "Environment :: Console",
            "Environment :: Web Environment",
            "Intended Audience :: Developers",
            "License :: OSI Approved :: BSD License",
            "Operating System :: OS Independent",
            "Programming Language :: Python :: 2.7",
            "Programming Language :: Python :: 3",
            "Topic :: Documentation",
            "Topic :: Software Development :: Documentation"
        ],
        "description": ".. _readthedocs.org: http://www.readthedocs.org\n.. _bower: http://www.bower.io\n.. _sphinx: http://www.sphinx-doc.org\n.. _compass: http://www.compass-style.org\n.. _sass: http://www.sass-lang.com\n.. _wyrm: http://www.github.com/snide/wyrm/\n.. _grunt: http://www.gruntjs.com\n.. _node: http://www.nodejs.com\n.. _demo: http://docs.readthedocs.org\n.. _hidden: http://sphinx-doc.org/markup/toctree.html\n\n**********************************\nLSST Design Documents Sphinx Theme\n**********************************\n\nForked from http://github.com/snide/sphinx_rtd_theme.\n\n.. contents:: \n\n\n.. image:: screen_mobile.png\n    :width: 100%\n\n\nUsing it\n========\n\nIn your ``requirements.txt`` add::\n\n   -e git://github.com/lsst-sqre/lsst_dd_rtd_theme.git@master#egg=lsst_dd_rtd_theme\n\nIn your ``conf.py`` file:\n\n.. code:: python\n\n    import lsst_dd_rtd_theme\n    html_theme = \"lsst_dd_rtd_theme\"\n    html_theme_path = [lsst_dd_rtd_theme.get_html_theme_path()]\n\n\nChangelog\n=========\n\n\nv0.1.8\n------\n\n* Start keeping changelog :)\n* Support for third and fourth level headers in the sidebar\n* Add support for Sphinx 1.3\n* Add sidebar headers for :caption: in Sphinx toctree\n* Clean up sidebar scrolling behavior so it never scrolls out of view\n\nHow the Table of Contents builds\n================================\n\nCurrently the left menu will build based upon any ``toctree(s)`` defined in your index.rst file.\nIt outputs 2 levels of depth, which should give your visitors a high level of access to your\ndocs. If no toctrees are set the theme reverts to sphinx's usual local toctree.\n\nIt's important to note that if you don't follow the same styling for your rST headers across\nyour documents, the toctree will misbuild, and the resulting menu might not show the correct\ndepth when it renders.\n\nAlso note that the table of contents is set with ``includehidden=true``. This allows you\nto set a hidden toc in your index file with the hidden_ property that will allow you\nto build a toc without it rendering in your index.\n\nBy default, the navigation will \"stick\" to the screen as you scroll. However if your toc\nis vertically too large, it will revert to static positioning. To disable the sticky nav\naltogether change the setting in ``conf.py``.\n\nContributing or modifying the theme\n===================================\n\nThe lsst_dd_rtd_theme is primarily a sass_ project that requires a few other sass libraries. I'm\nusing bower_ to manage these dependencies and sass_ to build the css. The good news is\nI have a very nice set of grunt_ operations that will not only load these dependencies, but watch\nfor changes, rebuild the sphinx demo docs and build a distributable version of the theme.\nThe bad news is this means you'll need to set up your environment similar to that\nof a front-end developer (vs. that of a python developer). That means installing node and ruby.\n\nSet up your environment\n-----------------------\n\n1. Install sphinx_ into a virtual environment.\n\n.. code::\n\n    pip install sphinx\n\n2. Install sass\n\n.. code::\n\n    gem install sass\n\n2. Install node, bower and grunt.\n\n.. code::\n\n    // Install node\n    brew install node\n\n    // Install bower and grunt\n    npm install -g bower grunt-cli\n\n    // Now that everything is installed, let's install the theme dependecies.\n    npm install\n\nNow that our environment is set up, make sure you're in your virtual environment, go to\nthis repository in your terminal and run grunt:\n\n.. code::\n\n    grunt\n\nThis default task will do the following **very cool things that make it worth the trouble**.\n\n1. It'll install and update any bower dependencies.\n2. It'll run sphinx and build new docs.\n3. It'll watch for changes to the sass files and build css from the changes.\n4. It'll rebuild the sphinx docs anytime it notices a change to .rst, .html, .js\n   or .css files.",
        "description_content_type": null,
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/lsst-sqre/lsst_dd_rtd/theme/",
        "keywords": "",
        "license": "MIT",
        "maintainer": "",
        "maintainer_email": "",
        "name": "lsst-dd-rtd-theme",
        "package_url": "https://pypi.org/project/lsst-dd-rtd-theme/",
        "platform": "",
        "project_url": "https://pypi.org/project/lsst-dd-rtd-theme/",
        "project_urls": {
            "Homepage": "https://github.com/lsst-sqre/lsst_dd_rtd/theme/"
        },
        "release_url": "https://pypi.org/project/lsst-dd-rtd-theme/0.2.1/",
        "requires_dist": null,
        "requires_python": "",
        "summary": "ReadTheDocs.org theme for Sphinx, 2013 version,forked by LSST/AURA.",
        "version": "0.2.1"
    },
    "last_serial": 3432589,
    "releases": {
        "0.1.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "072d83d3817f6f51c580be91a8dee3dc",
                    "sha256": "3ac45cfd5fc4afa46aa7fb3a4cd41688c31048fb3d1a1ce2335b830fccbf400d"
                },
                "downloads": -1,
                "filename": "lsst-dd-rtd-theme-0.1.0.tar.gz",
                "has_sig": false,
                "md5_digest": "072d83d3817f6f51c580be91a8dee3dc",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 695035,
                "upload_time": "2016-05-09T20:11:41",
                "url": "https://files.pythonhosted.org/packages/95/40/7546ee62c4ec972cf80dcabc25de9536b5f308964134b278b1ae588fdd33/lsst-dd-rtd-theme-0.1.0.tar.gz"
            }
        ],
        "0.2.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "2f857ce11dd6e04fb87043753b163ee8",
                    "sha256": "8479f9cc56171e154fac1009fcefcb9f2d2c8fbd83d7d2056b827858f5b865d5"
                },
                "downloads": -1,
                "filename": "lsst_dd_rtd_theme-0.2.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "2f857ce11dd6e04fb87043753b163ee8",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 49142,
                "upload_time": "2017-12-20T00:02:56",
                "url": "https://files.pythonhosted.org/packages/90/34/b92378549eeb519f177f61b59912a03198d27f56a727adf1fcaf83e07c90/lsst_dd_rtd_theme-0.2.0-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "ff9f323afe153761b578b93f147ba269",
                    "sha256": "8b28fcfd48d8007058d46c908dcd34610fc4094e3d2aba5d9f459198ca2fe821"
                },
                "downloads": -1,
                "filename": "lsst_dd_rtd_theme-0.2.0.tar.gz",
                "has_sig": false,
                "md5_digest": "ff9f323afe153761b578b93f147ba269",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 9793,
                "upload_time": "2017-12-20T00:02:58",
                "url": "https://files.pythonhosted.org/packages/92/b4/6f7cc3af6c6673f4623296fbaebf4bf1b7b3dde52fb6d06b9f432984c0ed/lsst_dd_rtd_theme-0.2.0.tar.gz"
            }
        ],
        "0.2.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "ced106aba51b2059434ad5e8071cd8da",
                    "sha256": "7733b69d1ab1972c61fc76aaf5634b8a81e73ba70bf72a04873e45ea338e5a6b"
                },
                "downloads": -1,
                "filename": "lsst_dd_rtd_theme-0.2.1.tar.gz",
                "has_sig": false,
                "md5_digest": "ced106aba51b2059434ad5e8071cd8da",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 699288,
                "upload_time": "2017-12-20T21:47:37",
                "url": "https://files.pythonhosted.org/packages/2b/7e/73166091ce39eeaef8c6b1bfab066d0ceeabcb861ad3b916bcf74bdab6c7/lsst_dd_rtd_theme-0.2.1.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "ced106aba51b2059434ad5e8071cd8da",
                "sha256": "7733b69d1ab1972c61fc76aaf5634b8a81e73ba70bf72a04873e45ea338e5a6b"
            },
            "downloads": -1,
            "filename": "lsst_dd_rtd_theme-0.2.1.tar.gz",
            "has_sig": false,
            "md5_digest": "ced106aba51b2059434ad5e8071cd8da",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 699288,
            "upload_time": "2017-12-20T21:47:37",
            "url": "https://files.pythonhosted.org/packages/2b/7e/73166091ce39eeaef8c6b1bfab066d0ceeabcb861ad3b916bcf74bdab6c7/lsst_dd_rtd_theme-0.2.1.tar.gz"
        }
    ]
}