Skip to main content

Insert images into Sphinx documentation using inline code and stylo

Project description


Project PyPI - License
Code Build Status

It is extremely early stages for this extension. It is not likely to be robust

Sphinx-Stylo is an extension to the Sphinx documentation tool that allows you to insert dynamically generated images created using the Stylo python library. Images can be defined using the .. stylo-image:: directive inline in your rst source files.

.. stylo-image::
   :align: center
   :img-width: 1920
   :img-height: 1080
   :display-width: 75%

   from stylo.color import FillColor
   from stylo.shape import Circle
   from stylo.image import SimpleImage

   color = FillColor("ffff00)
   circle = Circle(fill=True)

   image = SimpleImage(circle, color)

Then when a sphinx build is run your code will be executed and an image with the given dimensions will be inserted into the final HTML page.

If you want the code included alongside the inserted image then add the :include-code: option to the list of options under the directive.

You must store your image in a variable called image for it to be picked up by the extension.

Getting Started

If you want to use this extension in your documentation then you first need to install the extension using pip.

$ pip install sphinx-stylo

Then you need to add the extension to your extensions = [] list in your project's

extensions = [

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx-stylo-0.1.1.tar.gz (3.6 kB view hashes)

Uploaded Source

Built Distribution

sphinx_stylo-0.1.1-py3-none-any.whl (5.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page