Metadata-Version: 2.1
Name: 153957-theme
Version: 4.0
Summary: Theme for sigal generated photo albums
Keywords: photo album,theme,sigal
Author-email: Arne de Laat <arne@delaat.net>
Maintainer-email: Arne de Laat <arne@delaat.net>
Requires-Python: >=3.11
Description-Content-Type: text/markdown
Classifier: Environment :: Plugins
Classifier: Environment :: Web Environment
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Text Processing :: Markup :: HTML
Requires-Dist: sigal==2.4
Requires-Dist: mypy==1.8.0 ; extra == "dev"
Requires-Dist: flit==3.9.0 ; extra == "publish"
Project-URL: Repository, https://github.com/153957/153957-theme/
Provides-Extra: dev
Provides-Extra: publish

# Theme 153957

[![PyPI](https://img.shields.io/pypi/v/153957-theme)](https://pypi.org/project/153957-theme/)
[![License](https://img.shields.io/github/license/153957/153957-theme)](LICENSE)
[![Build](https://github.com/153957/153957-theme/actions/workflows/tests.yml/badge.svg?branch=main)](https://github.com/153957/153957-theme/actions)

[View demo album here](https://153957.github.io/153957-theme/)


## Photo gallery template

Web photo gallery templates adapted to my personal preferences.


## Usage

This section describes how to install and use this theme.


### Installation

Install the `153597-theme` package:

    $ pip install 153957-theme


### Configure

In `sigal.conf.py` configuration for an album the `theme` setting should be
a path to a theme directory. However, since this theme is provided as a Python
package its location might be harder to get. Two options are available for
configuration:

The theme can be configured as a plugin or you can get the path by importing
the package. By setting is as plugin the theme is automatically set.

Set `theme` to an empty string and add the theme and menu plugins:

    theme = ''
    plugins = ['theme_153957.theme', 'theme_153957.full_menu', …]

The alternative:

    from theme_153957 import theme
    theme = theme.get_path()
    plugins = ['theme_153957.full_menu', …]

