Skip to main content
PyCon US is happening May 14th-22nd in Pittsburgh, PA USA.  Learn more

Sphinx "css3image" extension

Project description

This plugin provides an enhanced image directive with additional CSS properties for Sphinx Documentation Generator.

Written by Fabrice Salvaire.

Installation

See sphinx-contrib for more details.

To install the plugin, you have to run these commands:

python setup.py build
python setup.py install

The PySpice source code is hosted at https://github.com/FabriceSalvaire/sphinx-css3image

To clone the Git repository, run this command in a terminal:

git clone git@github.com:FabriceSalvaire/sphinx-css3image

Usage

To load the plugin, you have to add it in your conf.py file.

extensions = [
  ...
  'sphinxcontrib.css3image',
  ]

Directives

This plugin adds a new directive css3image which is equivalent to the original, but with additional CSS properties:

.. css3image:: /_images/foo.png
  :margin: 10px 10px 10px 10px
  :margin-left: 10px
  :margin-right: 10px
  :margin-top: 10px
  :border-radius: 10px
  :transform-origin: 10px 10px
  :translate: 10px 10px
  :translateY: 10px
  :translateX: 10px
  :scaleX: 2.0
  :scaleY: 2.0
  :rotate: -10deg

Unit is mandatory for length value.

Supported by

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