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.
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.
Source Distribution
Built Distribution
Close
Hashes for sphinxcontrib-fancybox-0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3503d809daa5e98c0547c78efcbf48da1314fd962204abe6bee17931a4a13655 |
|
MD5 | a6fad9288af6888c34521c64d3fd6d0f |
|
BLAKE2b-256 | 90088353040b03db223176aec4491f156d98c4e9cba9ef1421ed2ae7e3e191b7 |
Close
Hashes for sphinxcontrib-fancybox-0.1.linux-x86_64.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f13b23ad127bbbc7c76339c573bd716eeb252b78b6847e100e5f0eb9c61a3869 |
|
MD5 | 8afe696a7d7bb149ecb5aa3ad410a6ad |
|
BLAKE2b-256 | 392b15acafabea49ac1feccbb7af319806687b1f5e64fc84afae3cc4e32f43b0 |