Skip to main content

Sphinx "fancybox" extension

Project description

Sphinx "fancybox" extension.


.. warning::

PLEASE LOOK AT ``sphinxcontrib-images``:



Fancybox is adaptation of the jQuery plugin `fancybox <>`_ in version **2.1.5*. Note that version
Fancybox v2 and later are distributed under a
`Creative Commons Attribution-NonCommercial 3.0 <>`_

Documentation: `<>`_

github: `<>`_

PYPI: `<>`_


Instalation through pip: ::

pip install sphinxcontrib-fancybox

or through github: ::

git clone
cd sphinxcontrib-fancybox
python install

Next, you have to add extension to `` in your sphinx project. ::

extensions = [



Fancybox directive place a thumbnail of picture you selected, and add some
`fancies`. If you click on image you get fullscreen box with that picture.

Example: ::

.. fancybox:: picture.png

By default all images on one page are in the same group (you can navigate
pressing `next` and `prev` buttons around this group).
If you want to add picture to another group you have to set `group`
parameter, like: ::

.. fancybox:: picture.png
:group: group2

You can change size of fancybox with 'width' and 'height' which are
passed as you set it: ::

.. fancybox:: picture.png
:width: 100%
:height: 2em

You can add some description which will be rendered as `title` attribute::

.. fancybox:: http://pictures.tld/picture.png

Some description

If you not set 'width' and 'height', defaults values are gathered from
``. There are two parameters which you can adjust: ::


Additionally you can set another css class with 'class' argument to
`fancybox` directive or set `fancybox_thumbnail_class` to add css class to
all `fancybox` directives.

All fancybox JS config options you can pass as dict to `fancybox_config` in
`` too.

For examples please look to documentation


* handling local files (not only remotes) (DONE)
* option to copying remote graphics as statics
* fallback for non html output (DONE)
* nested parsing fix
* JS should be handled only once, not on every image node
* width and height parameters (currently the thumbnail is set to 100x100px) (DONE)
* get default thumbnail size from config (DONE)
* generate thumbnails for big images

Questions and suggestions

If you have some suggstions, patches, problems - please write an email or
github message.

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

sphinxcontrib-fancybox-0.3.5.tar.gz (42.2 kB view hashes)

Uploaded Source

Built Distribution

sphinxcontrib_fancybox-0.3.5-py2-none-any.whl (44.5 kB view hashes)

Uploaded Python 2

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