sphinxcontrib-fancybox

0.3.2 BSD License    
  UNRATED

  358 downloads

Sphinx "fancybox" extension

description

download

specs

sphinxcontrib-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
read more   
Last updated on June 1st, 2012

#Sphinx extension #Sphinx fancybox #Sphinx #fancybox #extension #documentation

0 User reviews so far.

SUBMIT