{ "info": { "author": "Marek Kochanowski", "author_email": "maisie-sphinx-theme@kochanow.ski", "bugtrack_url": null, "classifiers": [ "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Programming Language :: Python" ], "description": "===================\nMaisie Sphinx Theme\n===================\n\n| Sphinx theme used by Maisie: https://docs.maisie.dev\n| Based on the Guzzle theme: http://guzzlephp.org\n\nInstallation\n============\n\nInstall via pip::\n\n $ pip install Maisie-Sphinx-Theme\n\nor if you have the code checked out locally::\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 maisie_sphinx_theme\n\n html_theme_path = maisie_sphinx_theme.html_theme_path()\n html_theme = 'maisie_sphinx_theme'\n\n # Register the theme as an extension to generate a sitemap.xml\n extensions.append(\"maisie_sphinx_theme\")\n\n # Maisie theme options (see theme.conf for more information)\n html_theme_options = {\n # Set the name of the project to appear in the sidebar\n \"project_nav_name\": \"Project Name\",\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 maisie_sphinx_theme\n\n html_theme_path = maisie_sphinx_theme.html_theme_path()\n html_theme = 'maisie_sphinx_theme'\n\n # Register the theme as an extension to generate a sitemap.xml\n extensions.append(\"maisie_sphinx_theme\")\n\n # Maisie theme options (see theme.conf for more information)\n html_theme_options = {\n\n # Set the path to a special layout to include for the homepage\n \"index_template\": \"special_index.html\",\n\n # Set the name of the project to appear in the left sidebar.\n \"project_nav_name\": \"Project Name\",\n\n # Set your Disqus short name to enable comments\n \"disqus_comments_shortname\": \"my_disqus_comments_short_name\",\n\n # Set you GA account ID to enable tracking\n \"google_analytics_account\": \"my_ga_account\",\n\n # Path to a touch icon\n \"touch_icon\": \"\",\n\n # Specify a base_url used to generate sitemap.xml links. If not\n # specified, then no sitemap will be built.\n \"base_url\": \"\",\n\n # Allow a separate homepage from the master_doc\n \"homepage\": \"index\",\n\n # Allow the project link to be overriden to a custom URL.\n \"projectlink\": \"http://myproject.url\",\n\n # Visible levels of the global TOC; -1 means unlimited\n \"globaltoc_depth\": 3,\n\n # If False, expand all TOC entries\n \"globaltoc_collapse\": False,\n\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.. note::\n\n If you are using Readthedocs, then you might run into an issue where they\n don't currently allow you to extend layout.html.\n\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/mkochanowski/maisie-sphinx-theme", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "Maisie-Sphinx-Theme", "package_url": "https://pypi.org/project/Maisie-Sphinx-Theme/", "platform": "", "project_url": "https://pypi.org/project/Maisie-Sphinx-Theme/", "project_urls": { "Homepage": "https://github.com/mkochanowski/maisie-sphinx-theme" }, "release_url": "https://pypi.org/project/Maisie-Sphinx-Theme/0.1.2/", "requires_dist": [ "Sphinx (>1.3)" ], "requires_python": "", "summary": "Sphinx theme used by Maisie.", "version": "0.1.2" }, "last_serial": 5431940, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "db7736f82142ec31b4f7a2eeb6620fc2", "sha256": "511ec429a34d9ca78d7a6db9d565f85066db76445b5fd5c3746e0d98dadac21a" }, "downloads": -1, "filename": "maisie_sphinx_theme-0.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "db7736f82142ec31b4f7a2eeb6620fc2", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 2554225, "upload_time": "2019-05-16T18:31:52", "url": "https://files.pythonhosted.org/packages/ec/e9/e1a31135f87643112e29b6677e9bd2d8e540d48328c117a97bf728d23889/maisie_sphinx_theme-0.1.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "f7bc3486c47e9034bef55fcde72b7526", "sha256": "8fb81b91a8e837c8554294fc8346234b4368e01b066ab62f889cf87f388c2094" }, "downloads": -1, "filename": "maisie-sphinx-theme-0.1.0.tar.gz", "has_sig": false, "md5_digest": "f7bc3486c47e9034bef55fcde72b7526", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2544748, "upload_time": "2019-05-16T18:31:57", "url": "https://files.pythonhosted.org/packages/08/4e/3bedb7820d47ae327cd73cf6678b9e64b65aaa0350a6a6587496ce413731/maisie-sphinx-theme-0.1.0.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "deb4def3b26d7b508a4695f167b90f59", "sha256": "1892e4ed9177e20072d72da6dc3ea34de2d78e47d2fe9823387a784adf9234ff" }, "downloads": -1, "filename": "Maisie_Sphinx_Theme-0.1.1-py3-none-any.whl", "has_sig": false, "md5_digest": "deb4def3b26d7b508a4695f167b90f59", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 2553788, "upload_time": "2019-05-21T18:13:16", "url": "https://files.pythonhosted.org/packages/ef/84/4fc272be0960a22906bfe03ed8458319f268da122ca4141d4e73d2e0cf0b/Maisie_Sphinx_Theme-0.1.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "426d11503a7fef5f380fa8908a1b24ed", "sha256": "dc69b32468a00d99ad1f7342757230ad03c1b526d212aeccb127fd9a29c5aa4e" }, "downloads": -1, "filename": "Maisie-Sphinx-Theme-0.1.1.tar.gz", "has_sig": false, "md5_digest": "426d11503a7fef5f380fa8908a1b24ed", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2545631, "upload_time": "2019-05-21T18:13:18", "url": "https://files.pythonhosted.org/packages/e5/33/4aba3d2b5cd4bf89430ae052c9a75212cbb113d22fc5716529ce50106aff/Maisie-Sphinx-Theme-0.1.1.tar.gz" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "3049ba47aa28bdfb154ca360a695073a", "sha256": "7085fe934e056b879934395060ae9c8c3d5f784bb4498799090f460933e224ef" }, "downloads": -1, "filename": "Maisie_Sphinx_Theme-0.1.2-py3-none-any.whl", "has_sig": false, "md5_digest": "3049ba47aa28bdfb154ca360a695073a", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 2553789, "upload_time": "2019-06-21T17:12:35", "url": "https://files.pythonhosted.org/packages/0e/25/537cdf0f35b0390282f70f96e411bfac0127ce1f9f0e5707b5e6d55218eb/Maisie_Sphinx_Theme-0.1.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "2ebbf03ed4a20592e5e7da8b981a7af3", "sha256": "f5ea9fa0eaf9954f043b48da9ca2e1836cc28fad443da2718f20cb5251ce6655" }, "downloads": -1, "filename": "Maisie-Sphinx-Theme-0.1.2.tar.gz", "has_sig": false, "md5_digest": "2ebbf03ed4a20592e5e7da8b981a7af3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2545632, "upload_time": "2019-06-21T17:12:38", "url": "https://files.pythonhosted.org/packages/3a/a8/ea36caa8f474c305efba18682a03c4f6165690ddf9d9f1147925c31d8439/Maisie-Sphinx-Theme-0.1.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "3049ba47aa28bdfb154ca360a695073a", "sha256": "7085fe934e056b879934395060ae9c8c3d5f784bb4498799090f460933e224ef" }, "downloads": -1, "filename": "Maisie_Sphinx_Theme-0.1.2-py3-none-any.whl", "has_sig": false, "md5_digest": "3049ba47aa28bdfb154ca360a695073a", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 2553789, "upload_time": "2019-06-21T17:12:35", "url": "https://files.pythonhosted.org/packages/0e/25/537cdf0f35b0390282f70f96e411bfac0127ce1f9f0e5707b5e6d55218eb/Maisie_Sphinx_Theme-0.1.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "2ebbf03ed4a20592e5e7da8b981a7af3", "sha256": "f5ea9fa0eaf9954f043b48da9ca2e1836cc28fad443da2718f20cb5251ce6655" }, "downloads": -1, "filename": "Maisie-Sphinx-Theme-0.1.2.tar.gz", "has_sig": false, "md5_digest": "2ebbf03ed4a20592e5e7da8b981a7af3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2545632, "upload_time": "2019-06-21T17:12:38", "url": "https://files.pythonhosted.org/packages/3a/a8/ea36caa8f474c305efba18682a03c4f6165690ddf9d9f1147925c31d8439/Maisie-Sphinx-Theme-0.1.2.tar.gz" } ] }