{ "info": { "author": "Kevin Sheppard", "author_email": "kevin.k.sheppard@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Framework :: Sphinx :: Extension", "Framework :: Sphinx :: Theme", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Natural Language :: English", "Programming Language :: Python", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Topic :: Documentation :: Sphinx" ], "description": "Material Sphinx Theme\n=====================\n\n**Continuous Integration**\n\n|Travis Build Status|\n\n**Release**\n\n|PyPI Status|\n\n**License**\n\n|MIT License|\n\nA Material Design theme for Sphinx documentation. Based on\n`Material for MkDocs `_,\nand `Guzzle Sphinx Theme `_.\n\nSee the theme's `demonstration site `_\nfor examples of rendered rst.\n\nInstallation\n------------\n\nInstall via pip:\n\n.. code-block:: bash\n\n $ pip install git+https://github.com/bashtage/sphinx-material\n\nor if you have the code checked out locally:\n\n.. code-block:: bash\n\n $ python setup.py install\n\nConfiguration\n-------------\n\nAdd the following to your conf.py:\n\n.. code-block:: python\n\n import sphinx_material\n\n # Register the theme as an extension to generate a sitemap.xml\n extensions.append('sphinx_material')\n\n # Choose the material theme\n html_theme = 'sphinx_material'\n # Get the them path\n html_theme_path = sphinx_material.html_theme_path()\n # Register the required helpers for the html context\n html_context = sphinx_material.get_html_context()\n\n\nThere are a lot more ways to customize this theme, as this more comprehensive\nexample shows:\n\n.. code-block:: python\n\n import sphinx_material\n\n # Required theme setup\n extensions.append('sphinx_material')\n html_theme = 'sphinx_material'\n html_theme_path = sphinx_material.html_theme_path()\n html_context = sphinx_material.get_html_context()\n\n # Material theme options (see theme.conf for more information)\n html_theme_options = {\n\n # Set the name of the project to appear in the navigation.\n 'nav_name': 'Project Name',\n\n # Set you GA account ID to enable tracking\n 'google_analytics_account': 'UA-XXXXX',\n\n # Specify a base_url used to generate sitemap.xml. If not\n # specified, then no sitemap will be built.\n 'base_url': 'https://project.github.io/project',\n\n # Set the color and the accent color\n 'color_primary': 'blue',\n 'color_accent': 'light-blue'\n\n # Set the repo location to get a badge with stats\n 'repo_url': 'https://github.com/project/project/',\n 'repo_name': 'Project',\n\n # Visible levels of the global TOC; -1 means unlimited\n 'globaltoc_depth': 3,\n # If False, expand all TOC entries\n 'globaltoc_collapse': False,\n # If True, show hidden TOC entries\n 'globaltoc_includehidden': False,\n }\n\nCustomizing the layout\n----------------------\n\nYou can customize the theme by overriding Jinja template blocks. For example,\n'layout.html' contains several blocks that can be overridden or extended.\n\nPlace a 'layout.html' file in your project's '/_templates' directory.\n\n.. code-block:: bash\n\n mkdir source/_templates\n touch source/_templates/layout.html\n\nThen, configure your 'conf.py':\n\n.. code-block:: python\n\n templates_path = ['_templates']\n\nFinally, edit your override file 'source/_templates/layout.html':\n\n::\n\n {# Import the theme's layout. #}\n {% extends '!layout.html' %}\n\n {%- block extrahead %}\n {# Add custom things to the head HTML tag #}\n {# Call the parent block #}\n {{ super() }}\n {%- endblock %}\n\n.. |Travis Build Status| image:: https://travis-ci.org/bashtage/sphinx-material.svg?branch=master\n :target: https://travis-ci.org/bashtage/sphinx-material\n\n.. |PyPI Status| image:: https://badge.fury.io/py/sphinx-material.svg\n :target: https://badge.fury.io/py/sphinx-material\n\n.. |MIT License| image:: https://img.shields.io/badge/License-MIT-blue.svg\n :target: https://opensource.org/licenses/MIT-Clause\n\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/bashtage/sphinx-material", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "sphinx-material", "package_url": "https://pypi.org/project/sphinx-material/", "platform": "", "project_url": "https://pypi.org/project/sphinx-material/", "project_urls": { "Homepage": "https://github.com/bashtage/sphinx-material" }, "release_url": "https://pypi.org/project/sphinx-material/0.0.15/", "requires_dist": [ "sphinx (>=2.0)", "beautifulsoup4", "python-slugify[unidecode]", "css-html-js-minify", "lxml", "black (==19.3b0)" ], "requires_python": ">=3.6", "summary": "Material sphinx theme", "version": "0.0.15" }, "last_serial": 5838570, "releases": { "0.0.10": [ { "comment_text": "", "digests": { "md5": "980b73188d6cd51ac8ee7ffc002286b8", "sha256": "fbb9d5ae782b5ce11dee32ca76e6eb0cf6b61fc7fc7ef466c95a6a1678d26d70" }, "downloads": -1, "filename": "sphinx_material-0.0.10-py3-none-any.whl", "has_sig": false, "md5_digest": "980b73188d6cd51ac8ee7ffc002286b8", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 505564, "upload_time": "2019-08-29T15:22:40", "url": "https://files.pythonhosted.org/packages/31/ad/755ddbe1acbebf11ba58b1f942927b9978e2795645895a233131a8141a48/sphinx_material-0.0.10-py3-none-any.whl" } ], "0.0.11": [ { "comment_text": "", "digests": { "md5": "b70234980c4ee837fba5435069b33478", "sha256": "a6419911a1ded9c3391b4560e285699f8273c32e497699186c96dda9df36bc1b" }, "downloads": -1, "filename": "sphinx_material-0.0.11-py3-none-any.whl", "has_sig": false, "md5_digest": "b70234980c4ee837fba5435069b33478", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 506088, "upload_time": "2019-09-01T08:51:44", "url": "https://files.pythonhosted.org/packages/f0/52/94538dfb9304dc847964e894b8f20775a4ea88341604ec3af3973126047e/sphinx_material-0.0.11-py3-none-any.whl" } ], "0.0.12": [ { "comment_text": "", "digests": { "md5": "cfad3f802b2098f47ef9c201685a8362", "sha256": "ce0682d533f6b379fd777b4c686987ab2da3f2fb61994dac9ccb0ff10ffa4b24" }, "downloads": -1, "filename": "sphinx_material-0.0.12-py3-none-any.whl", "has_sig": false, "md5_digest": "cfad3f802b2098f47ef9c201685a8362", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 506247, "upload_time": "2019-09-01T22:35:06", "url": "https://files.pythonhosted.org/packages/1a/1e/bfe88862d9fb5ee5e0611ac721351fa5ba9f7e94d11b06097bf6246f0c70/sphinx_material-0.0.12-py3-none-any.whl" } ], "0.0.13": [ { "comment_text": "", "digests": { "md5": "90f5edc7830aa06c3bbfd298810d73b2", "sha256": "c54f76267cc318cdc4b9c16bf067b6d34eaed8570870ef465abb7cdd33a4f9a5" }, "downloads": -1, "filename": "sphinx_material-0.0.13-py3-none-any.whl", "has_sig": false, "md5_digest": "90f5edc7830aa06c3bbfd298810d73b2", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 506312, "upload_time": "2019-09-02T15:52:17", "url": "https://files.pythonhosted.org/packages/e1/0b/2d06934acebd79e16cead79c6385d271fa18ebc73b44c96e92fa5bc6cc12/sphinx_material-0.0.13-py3-none-any.whl" } ], "0.0.14": [ { "comment_text": "", "digests": { "md5": "3208ed5e1ccaa9648a45e5fdfef77633", "sha256": "13c48c26c46442b7ec34555d54a4bc56201536e80a8aef9f0a694ea7e3a13e76" }, "downloads": -1, "filename": "sphinx_material-0.0.14-py3-none-any.whl", "has_sig": false, "md5_digest": "3208ed5e1ccaa9648a45e5fdfef77633", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 506374, "upload_time": "2019-09-13T16:38:05", "url": "https://files.pythonhosted.org/packages/5e/0b/ca3d05ab5b8ca9490c9cf8de4753619cd64633ed55cae7451c474a4b6171/sphinx_material-0.0.14-py3-none-any.whl" } ], "0.0.15": [ { "comment_text": "", "digests": { "md5": "583943e0f33d83a0500b233b197f30d3", "sha256": "942886d2bc4a58a6366983c8f2513413c714d1701d6d72272b27bf71bf939321" }, "downloads": -1, "filename": "sphinx_material-0.0.15-py3-none-any.whl", "has_sig": false, "md5_digest": "583943e0f33d83a0500b233b197f30d3", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 506447, "upload_time": "2019-09-16T23:08:06", "url": "https://files.pythonhosted.org/packages/4c/b0/fda057b3418bedb129a393b0d0d89d372de868917cd234bfa4478cbef28f/sphinx_material-0.0.15-py3-none-any.whl" } ], "0.0.3": [ { "comment_text": "", "digests": { "md5": "2f052d1d01db973fc56d0d6217a2b213", "sha256": "c0fc5caa3b1f36af6a37cb7aeceb99c055e73af602c7e281bd3698c5c91c6e53" }, "downloads": -1, "filename": "sphinx_material-0.0.3-py3-none-any.whl", "has_sig": false, "md5_digest": "2f052d1d01db973fc56d0d6217a2b213", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 503943, "upload_time": "2019-08-23T17:50:04", "url": "https://files.pythonhosted.org/packages/7c/51/b4c999f863ae6b31219e22493346c7d4de01424561b74506a661ac408ff4/sphinx_material-0.0.3-py3-none-any.whl" } ], "0.0.4": [ { "comment_text": "", "digests": { "md5": "ca9d1e462bd63efb8bd6e2b532d80c79", "sha256": "158eea16b0452f0b732f806f84bd7e2ab5352a02e5453c63423a8c366a2957de" }, "downloads": -1, "filename": "sphinx_material-0.0.4-py3-none-any.whl", "has_sig": false, "md5_digest": "ca9d1e462bd63efb8bd6e2b532d80c79", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 503979, "upload_time": "2019-08-23T17:53:54", "url": "https://files.pythonhosted.org/packages/0e/a6/7be4d0e11b36a07b69e8546c17716b8c845d742962d7d1f8c40834d68eee/sphinx_material-0.0.4-py3-none-any.whl" } ], "0.0.5": [ { "comment_text": "", "digests": { "md5": "ee81244e5ee3774e1fff6b3abdaaf501", "sha256": "55c05c481da0823b289c5d3b1e088f5f64b5c15404f64853b2e1ae2051f55974" }, "downloads": -1, "filename": "sphinx_material-0.0.5-py3-none-any.whl", "has_sig": false, "md5_digest": "ee81244e5ee3774e1fff6b3abdaaf501", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 505356, "upload_time": "2019-08-26T16:27:51", "url": "https://files.pythonhosted.org/packages/f4/d6/f776974c0fb160701c71bcecae07c97b44d1f03de08f58a4290a1bbb0c7c/sphinx_material-0.0.5-py3-none-any.whl" } ], "0.0.6": [ { "comment_text": "", "digests": { "md5": "08740984bb5bfd6338254a6a7a1d4d78", "sha256": "a70e835aa5b68c8844f84e6e644cee12300bb2d0f0fbf7748ac1203d0beb83f5" }, "downloads": -1, "filename": "sphinx_material-0.0.6-py3-none-any.whl", "has_sig": false, "md5_digest": "08740984bb5bfd6338254a6a7a1d4d78", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 505403, "upload_time": "2019-08-26T23:36:33", "url": "https://files.pythonhosted.org/packages/6b/35/e01c9c4343c0695b56168fea27ff94f6f844fa59c9e74aab3f78ebb5a531/sphinx_material-0.0.6-py3-none-any.whl" } ], "0.0.7": [ { "comment_text": "", "digests": { "md5": "57c6cf9b4784e1b7836ceaded3169c94", "sha256": "8bf930fcd538a6a23f5cfe25f0de0291e8f6a4d78b3ad66426994e84baf0667d" }, "downloads": -1, "filename": "sphinx_material-0.0.7-py3-none-any.whl", "has_sig": false, "md5_digest": "57c6cf9b4784e1b7836ceaded3169c94", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 505398, "upload_time": "2019-08-28T11:51:31", "url": "https://files.pythonhosted.org/packages/e9/fc/88cfc8d1b85d492bbd4592039f8c4e0da6f782d79f3b72ba249aec8e10e6/sphinx_material-0.0.7-py3-none-any.whl" } ], "0.0.8": [ { "comment_text": "", "digests": { "md5": "12efb49bac00f75e8a11dceae9f9e2af", "sha256": "3d490debd63378398aa70af8e02761e98254f66dfa749290f5e3fb0695d9bcab" }, "downloads": -1, "filename": "sphinx_material-0.0.8-py3-none-any.whl", "has_sig": false, "md5_digest": "12efb49bac00f75e8a11dceae9f9e2af", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 505421, "upload_time": "2019-08-28T23:27:03", "url": "https://files.pythonhosted.org/packages/10/8f/616b123759a33c52a3053b90e88f345779fee5a672ad70cdb06e0e421994/sphinx_material-0.0.8-py3-none-any.whl" } ], "0.0.9": [ { "comment_text": "", "digests": { "md5": "20c4aab40818a9a73cbc237b65f5fcb7", "sha256": "0775ef8a12c4f18d9cefb968b0187bb729032374da21418952ace0142d88f20a" }, "downloads": -1, "filename": "sphinx_material-0.0.9-py3-none-any.whl", "has_sig": false, "md5_digest": "20c4aab40818a9a73cbc237b65f5fcb7", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 505534, "upload_time": "2019-08-29T00:49:04", "url": "https://files.pythonhosted.org/packages/e4/ca/b8a9790cd659ae8e06817ca0a592aeaf3bd430437e5df2279b67cf92578e/sphinx_material-0.0.9-py3-none-any.whl" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "583943e0f33d83a0500b233b197f30d3", "sha256": "942886d2bc4a58a6366983c8f2513413c714d1701d6d72272b27bf71bf939321" }, "downloads": -1, "filename": "sphinx_material-0.0.15-py3-none-any.whl", "has_sig": false, "md5_digest": "583943e0f33d83a0500b233b197f30d3", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.6", "size": 506447, "upload_time": "2019-09-16T23:08:06", "url": "https://files.pythonhosted.org/packages/4c/b0/fda057b3418bedb129a393b0d0d89d372de868917cd234bfa4478cbef28f/sphinx_material-0.0.15-py3-none-any.whl" } ] }