Update the docs.
This commit is contained in:
@@ -45,32 +45,39 @@ How to Use
|
||||
|
||||
::
|
||||
|
||||
$ sigal [-h] [--version] [-f] input_dir output_dir
|
||||
$ sigal [-h] [--version] [-f] [-v] [-d] [-c CONFIG] [-t THEME]
|
||||
input_dir [output_dir]
|
||||
|
||||
Required arguments:
|
||||
|
||||
``input_dir``
|
||||
input directory
|
||||
|
||||
``output_dir``
|
||||
output directory
|
||||
|
||||
Optional arguments:
|
||||
|
||||
``output_dir``
|
||||
output directory (default: ``_build/``)
|
||||
|
||||
``-h|--help``
|
||||
Show this help message and exit
|
||||
show this help message and exit
|
||||
|
||||
``--version``
|
||||
Show program's version number and exit
|
||||
show program's version number and exit
|
||||
|
||||
``-f|--force``
|
||||
Force the reprocessing of existing images and thumbnails
|
||||
force the reprocessing of existing images and thumbnails
|
||||
|
||||
``-v, --verbose``
|
||||
Show all messages
|
||||
show all messages
|
||||
|
||||
``-d, --debug``
|
||||
Show all message, including debug messages
|
||||
show all message, including debug messages
|
||||
|
||||
``-c CONFIG, --config CONFIG``
|
||||
configuration file (default: ``<input_dir>/sigal.conf.py``)
|
||||
|
||||
``-t THEME, --theme THEME``
|
||||
specify a theme directory, or a theme name for the themes included with Sigal
|
||||
|
||||
|
||||
Configuration
|
||||
@@ -88,7 +95,9 @@ Album information
|
||||
-----------------
|
||||
|
||||
Information on an album can be given in a file using the markdown syntax,
|
||||
named `index.mkd` ::
|
||||
named ``index.mkd`` :
|
||||
|
||||
::
|
||||
|
||||
Title: Another example gallery
|
||||
Representative: test2.jpg
|
||||
|
||||
@@ -1,43 +1,45 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# All configuration values have a default; values that are commented out serve
|
||||
# to show the default. Default values are specified when modified in this
|
||||
# example config file
|
||||
|
||||
# theme :
|
||||
# Theme :
|
||||
# - colorbox (default), galleria, or the path to a custom theme directory
|
||||
# theme = 'colorbox'
|
||||
|
||||
# size of resized image
|
||||
# Size of resized image
|
||||
# img_size = (640, 480)
|
||||
|
||||
# generate thumbnails
|
||||
# Generate thumbnails
|
||||
# make_thumbs = True
|
||||
|
||||
# subdirectory of the thumbnails
|
||||
# Subdirectory of the thumbnails
|
||||
# thumb_dir = 'thumbnails'
|
||||
|
||||
# prefix and/or suffix for thumbnail names (default: '')
|
||||
# Prefix and/or suffix for thumbnail names (default: '')
|
||||
# thumb_prefix =
|
||||
thumb_suffix = '.tn'
|
||||
|
||||
# thumbnail size (default: (150, 112))
|
||||
# Thumbnail size (default: (150, 112))
|
||||
thumb_size = (200, 150)
|
||||
|
||||
# crop the image to fill the box
|
||||
# Crop the image to fill the box
|
||||
# thumb_fit = True
|
||||
|
||||
# keep original image (default: False)
|
||||
# Keep original image (default: False)
|
||||
keep_orig = True
|
||||
|
||||
# subdirectory for original images
|
||||
# Subdirectory for original images
|
||||
# orig_dir = 'original'
|
||||
|
||||
# jpeg quality
|
||||
# Jpeg quality
|
||||
# jpg_quality = 90
|
||||
|
||||
# keep exif metadatas in output image (default: False)
|
||||
# Keep exif metadatas in output image (default: False)
|
||||
copy_exif = True
|
||||
|
||||
# add a copyright text on the image (default: '')
|
||||
# Add a copyright text on the image (default: '')
|
||||
copyright = "An example copyright message"
|
||||
|
||||
# Google Analytics tracking code (UA-xxxx-x)
|
||||
|
||||
Reference in New Issue
Block a user