{ "info": { "author": "Alex Carney", "author_email": "alcarneyme@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 3.7", "Programming Language :: Python :: 3 :: Only", "Topic :: Documentation", "Topic :: Documentation :: Sphinx" ], "description": "# Sphinx-Stylo\n\n| | |\n|:--:|--|\n|**Project** | [![PyPI - License](https://img.shields.io/pypi/l/sphinx-stylo.svg)](https://opensource.org/licenses/MIT)|\n|**Code**| [![Build Status](https://travis-ci.org/alcarney/sphinx-stylo.svg?branch=develop)](https://travis-ci.org/alcarney/sphinx-stylo) |\n|**PyPi**|[![PyPI](https://img.shields.io/pypi/v/sphinx-stylo.svg)](https://pypi.org/project/sphinx-stylo)|\n\n\n**It is extremely early stages for this extension. It is not likely to be robust**\n\nSphinx-Stylo is an extension to the [Sphinx](http://www.sphinx-doc.org/en/master/)\ndocumentation tool that allows you to insert dynamically generated images created using\nthe [Stylo](https://alcarney.github.io/stylo) python library. Images can be defined\nusing the `.. stylo-image::` directive inline in your rst source files.\n\n```rst\n.. stylo-image::\n :align: center\n :img-width: 1920\n :img-height: 1080\n :display-width: 75%\n\n from stylo.color import FillColor\n from stylo.shape import Circle\n from stylo.image import SimpleImage\n\n color = FillColor(\"ffff00)\n circle = Circle(fill=True)\n\n image = SimpleImage(circle, color)\n```\n\nThen when a sphinx build is run your code will be executed and an image with the\ngiven dimensions will be inserted into the final HTML page. \n\nIf you want the code included alongside the inserted image then add the `:include-code:`\noption to the list of options under the directive.\n\nYou **must** store your image in a variable called `image` for it to be picked up by the\nextension.\n\n## Getting Started\n\nIf you want to use this extension in your documentation then you first need to\ninstall the extension using `pip`.\n\n```sh\n$ pip install sphinx-stylo\n```\n\nThen you need to add the extension to your `extensions = []` list in your project's `conf.py`\n\n```py\nextensions = [\n ...\n \"sphinx_stylo\"\n]\n```\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/alcarney/sphinx-stylo", "keywords": "", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "sphinx-stylo", "package_url": "https://pypi.org/project/sphinx-stylo/", "platform": "", "project_url": "https://pypi.org/project/sphinx-stylo/", "project_urls": { "Homepage": "https://github.com/alcarney/sphinx-stylo" }, "release_url": "https://pypi.org/project/sphinx-stylo/0.1.1/", "requires_dist": [ "sphinx", "stylo" ], "requires_python": ">=3.5", "summary": "Insert images into Sphinx documentation using inline code and stylo", "version": "0.1.1" }, "last_serial": 4425192, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "4722c2266fc892dd523c9a6652fd79fb", "sha256": "9df3b0d5ee9d0d25d058f73fa5c200f89a75cc65f041eb1b206e7ddf02fc37f8" }, "downloads": -1, "filename": "sphinx-stylo-0.1.0.tar.gz", "has_sig": false, "md5_digest": "4722c2266fc892dd523c9a6652fd79fb", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 3387, "upload_time": "2018-10-28T19:51:08", "url": "https://files.pythonhosted.org/packages/01/87/c965a1b0b475d9d8d7edbf14f76112ea056bd55f343a5f2a6f0b8e67450c/sphinx-stylo-0.1.0.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "318c9593fdca23bf8fe499c231a869d4", "sha256": "dc9ef2ec95d30f08619f4b3264308fbf365bb2c8442de165c3eac0025800b7d4" }, "downloads": -1, "filename": "sphinx_stylo-0.1.1-py3-none-any.whl", "has_sig": false, "md5_digest": "318c9593fdca23bf8fe499c231a869d4", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 4992, "upload_time": "2018-10-28T20:33:40", "url": "https://files.pythonhosted.org/packages/9c/f7/d3f7ae4a7d5ffd679acaf732cc93eec94fffcd4546e06ffcd705b2e7590c/sphinx_stylo-0.1.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "0a778710f8f318c8dcdd6de7b293787a", "sha256": "2c53983054468455e2b3c6b66332932f8349a71aebeda6211ad42c819e60a03f" }, "downloads": -1, "filename": "sphinx-stylo-0.1.1.tar.gz", "has_sig": false, "md5_digest": "0a778710f8f318c8dcdd6de7b293787a", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 3562, "upload_time": "2018-10-28T20:33:41", "url": "https://files.pythonhosted.org/packages/a0/2b/5219c6c27c4b4afbfb892c1037ee59fca60ac6b585bb8bca08736d7aa265/sphinx-stylo-0.1.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "318c9593fdca23bf8fe499c231a869d4", "sha256": "dc9ef2ec95d30f08619f4b3264308fbf365bb2c8442de165c3eac0025800b7d4" }, "downloads": -1, "filename": "sphinx_stylo-0.1.1-py3-none-any.whl", "has_sig": false, "md5_digest": "318c9593fdca23bf8fe499c231a869d4", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": ">=3.5", "size": 4992, "upload_time": "2018-10-28T20:33:40", "url": "https://files.pythonhosted.org/packages/9c/f7/d3f7ae4a7d5ffd679acaf732cc93eec94fffcd4546e06ffcd705b2e7590c/sphinx_stylo-0.1.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "0a778710f8f318c8dcdd6de7b293787a", "sha256": "2c53983054468455e2b3c6b66332932f8349a71aebeda6211ad42c819e60a03f" }, "downloads": -1, "filename": "sphinx-stylo-0.1.1.tar.gz", "has_sig": false, "md5_digest": "0a778710f8f318c8dcdd6de7b293787a", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 3562, "upload_time": "2018-10-28T20:33:41", "url": "https://files.pythonhosted.org/packages/a0/2b/5219c6c27c4b4afbfb892c1037ee59fca60ac6b585bb8bca08736d7aa265/sphinx-stylo-0.1.1.tar.gz" } ] }