{ "info": { "author": "Steve Johnson", "author_email": "steve@steveasleep.com", "bugtrack_url": null, "classifiers": [], "description": "A Better Sphinx Theme\n---------------------\n\n`Read the documentation`_\n\n`See a demo`_\n\n.. _Read the documentation: https://sphinx-better-theme.readthedocs.org/en/latest/\n\n.. _See a demo: https://sphinx-better-theme.readthedocs.org/en/latest/demos.html\n\nWhat is this?\n^^^^^^^^^^^^^\n\nThis is a modified version of the default Sphinx theme with the following\ngoals:\n\n1. Remove frivolous colors, especially hard-coded ones\n2. Improve readability by limiting width and using more whitespace\n3. Encourage visual customization through CSS, not themeconf\n4. Use semantic markup\n\nv0.1 meets goals one and two. Goal three is partially complete; it's simple to\nadd your own CSS file without creating a whole new theme. `Open a ticket` if\nyou'd like something changed.\n\n.. _Open a ticket: https://github.com/irskep/sphinx-better-theme/issues/new\n\nCompatibility\n\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nsphinx-better-theme is compatible with Sphinx 0.6.4+ and Jinja 2.3.1+. Older\nversions may work but have not been tested.\n\nInstallation\n^^^^^^^^^^^^\n\nMethod 1: Adding to your source tree\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nThis method is preferred due to the frequency with which sphinx-better-theme is\nimproved.\n\n1. Put the theme in your source tree. If you use git, you can add\n ``sphinx-better-theme``'s repository as a submodule. Otherwise you can\n `download the zip file`_ and expand it somewhere predictable. Here's an\n example using git::\n\n > git submodule add \\\n https://github.com/irskep/sphinx-better-theme.git \\\n docs/sphinx-better-theme\n > git submodule update --init\n\n.. _download the zip file: https://github.com/irskep/sphinx-better-theme/archive/master.zip\n\n2. Add the parent folder of the theme to your ``conf.py``. If you use the\n folder structure in the block above, you'd do it like this::\n\n html_theme_path = ['sphinx-better-theme']\n\n (because the theme path is ``sphinx-better-theme/better``.)\n\n3. Set ``html_theme`` to ``'better'`` in your ``conf.py``.\n\nMethod 2: Installing to site-packages\n\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\"\n\nIf adding the theme to your source tree is impractical, if you need to share it\namong several repositories, or if you prefer a more serene frequency of\nupdates, you can install it like a regular Python package.\n\n`Download the zip file`_ and run the usual command::\n\n > python setup.py install\n\n.. _Download the zip file.: https://github.com/irskep/sphinx-better-theme/archive/master.zip\n\nOr install from PyPI::\n\n > pip install sphinx-better-theme\n\nTo use the theme, set ``html_theme_path`` to contain\n``better.better_theme_path``, and set ``html_theme`` to ``'better'``::\n\n from better import better_theme_path\n html_theme_path = [better_theme_path]\n html_theme = 'better'", "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/irskep/sphinx-better-theme", "keywords": null, "license": "LICENSE", "maintainer": null, "maintainer_email": null, "name": "sphinx-better-theme", "package_url": "https://pypi.org/project/sphinx-better-theme/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/sphinx-better-theme/", "project_urls": { "Download": "UNKNOWN", "Homepage": "http://github.com/irskep/sphinx-better-theme" }, "release_url": "https://pypi.org/project/sphinx-better-theme/0.1.5/", "requires_dist": null, "requires_python": null, "summary": "A nice-looking, customizable Sphinx theme", "version": "0.1.5" }, "last_serial": 3610094, "releases": { "0.1": [ { "comment_text": "", "digests": { "md5": "17ffd5cb8b86c66f56fef0c09981145d", "sha256": "1f781b09cb8a18f618cc60b90bb07e020bf1824750e8904c23d4a4e4c1e1a27f" }, "downloads": -1, "filename": "sphinx-better-theme-0.1.tar.gz", "has_sig": false, "md5_digest": "17ffd5cb8b86c66f56fef0c09981145d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6546, "upload_time": "2013-08-20T01:32:16", "url": "https://files.pythonhosted.org/packages/85/67/e0f586c10ddd2850ca0b6e4026771e080dbfaef76c6a2a5e7dea101a0c29/sphinx-better-theme-0.1.tar.gz" } ], "0.1.4": [ { "comment_text": "", "digests": { "md5": "b82174c84d60cb9a2a1d341791209c3e", "sha256": "941a21a4a2f884b8875a367edd3e445f2fdb93a82478d2597336cc91a2fe2402" }, "downloads": -1, "filename": "sphinx-better-theme-0.1.4.tar.gz", "has_sig": false, "md5_digest": "b82174c84d60cb9a2a1d341791209c3e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7401, "upload_time": "2013-09-08T19:09:28", "url": "https://files.pythonhosted.org/packages/51/8c/3c01906a8002957bb2fc7a28e449e8aba226b4b8746c09be905fef34e968/sphinx-better-theme-0.1.4.tar.gz" } ], "0.1.5": [ { "comment_text": "", "digests": { "md5": "4dabb8bf514e66b10b9fd378f9bff04f", "sha256": "420570d80d8cab25b35cef2b79619104675777dff5a23deebe9ba2191d48c1ce" }, "downloads": -1, "filename": "sphinx-better-theme-0.1.5.tar.gz", "has_sig": false, "md5_digest": "4dabb8bf514e66b10b9fd378f9bff04f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7276, "upload_time": "2013-10-05T03:02:18", "url": "https://files.pythonhosted.org/packages/70/a3/5b54286499282ec1e18e48674bebe38803c07ba6615445848993fe90ecb4/sphinx-better-theme-0.1.5.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "4dabb8bf514e66b10b9fd378f9bff04f", "sha256": "420570d80d8cab25b35cef2b79619104675777dff5a23deebe9ba2191d48c1ce" }, "downloads": -1, "filename": "sphinx-better-theme-0.1.5.tar.gz", "has_sig": false, "md5_digest": "4dabb8bf514e66b10b9fd378f9bff04f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7276, "upload_time": "2013-10-05T03:02:18", "url": "https://files.pythonhosted.org/packages/70/a3/5b54286499282ec1e18e48674bebe38803c07ba6615445848993fe90ecb4/sphinx-better-theme-0.1.5.tar.gz" } ] }