Skip to main content

Sphinx "fancybox" extension

Project description

Sphinx "fancybox" extension.

Fancybox
========

Fancybox is adaptation of `http://fancybox.net/`_ in version **1.3.4**.

Installation
------------

Instalation through pip: ::

pip install sphinxcontrib-fancybox

or through github: ::

git clone https://github.com/spinus/sphinxcontrib-fancybox
cd sphinxcontrib-fancybox
python setup.py install

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

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


Directives
----------

fancybox:

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


TODO
----

* fallback for non html output
* width and height parameters (currently the thumbnail is set to 100x100px)
* get default thumbnail size from config


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.

Files for sphinxcontrib-fancybox, version 0.1
Filename, size File type Python version Upload date Hashes
Filename, size sphinxcontrib-fancybox-0.1.linux-x86_64.tar.gz (7.1 kB) File type Dumb Binary Python version any Upload date Hashes View hashes
Filename, size sphinxcontrib-fancybox-0.1.tar.gz (5.5 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page