Browse Source

Docs for bundled themes, pillow ...

pull/34/head
Simon Conseil 13 years ago
parent
commit
ad475d2c12
  1. 15
      README.rst
  2. 2
      docs/album_information.rst
  3. 14
      docs/index.rst
  4. 3
      docs/installation.rst
  5. 15
      docs/themes.rst

15
README.rst

@ -26,7 +26,20 @@ Links :
* Source, issues and pull requests on `Github`_
* Releases on `PyPI`_
.. _galleria: http://galleria.io/
Themes & Demo
-------------
Sigal comes with two themes, based on the `colorbox`_ and `galleria`_
Javascript libraries:
- `colorbox demo`_
- `galleria demo`_
.. _website: http://sigal.saimon.org/
.. _Github: https://github.com/saimn/sigal/
.. _PyPI: http://pypi.python.org/pypi/sigal
.. _galleria: http://galleria.io/
.. _colorbox: http://www.jacklmoore.com/colorbox
.. _galleria demo: http://saimon.org/sigal-demo/galleria/
.. _colorbox demo: http://saimon.org/sigal-demo/colorbox/

2
docs/album_information.rst

@ -1,5 +1,3 @@
.. _album-information-label:
===================
Album information
===================

14
docs/index.rst

@ -1,19 +1,5 @@
.. include:: ../README.rst
Themes & Demo
-------------
Sigal comes with two themes, based on the `colorbox`_ and `galleria`_
Javascript libraries:
- `colorbox demo`_
- `galleria demo`_
.. _galleria: http://galleria.io/
.. _colorbox: http://www.jacklmoore.com/colorbox
.. _galleria demo: http://saimon.org/sigal-demo/galleria/
.. _colorbox demo: http://saimon.org/sigal-demo/colorbox/
Documentation
-------------

3
docs/installation.rst

@ -35,6 +35,9 @@ developpement packages of libjpeg, freetype2 and zlib.
apt-get build-dep python-dev python-imaging
Debian/Sid users can use the experimental ``python-imaging`` package that is
built from Pillow source.
- For Archlinux, there is a package_ for sigal in the AUR which already uses
Pillow.

15
docs/themes.rst

@ -7,6 +7,19 @@ be located in ``THEME_DIR/templates``.
.. _Jinja2: http://jinja.pocoo.org/docs/
Bundled themes
~~~~~~~~~~~~~~
Sigal comes with two themes, based on the `colorbox`_ and `galleria`_
Javascript libraries, and located in the ``sigal/themes`` folder.
The stylesheets for these themes are written with sass_ (``gem install sass``).
A Makefile is available to compile the scss files to css
(``sigal/themes/Makefile``).
.. _galleria: http://galleria.io/
.. _colorbox: http://www.jacklmoore.com/colorbox
.. _sass: http://sass-lang.com/
Variables
~~~~~~~~~
@ -44,7 +57,7 @@ You can use the following variables in your template:
``meta`` and ``description``
Meta data and album description. For details how to annotate your albums
with meta data, see :ref:`album-information-label`.
with meta data, see :doc:`album_information`.
``theme.name``
Name of the currently used theme.

Loading…
Cancel
Save