Update docs and changelog.
This commit is contained in:
@@ -7,6 +7,23 @@ Version 0.8.dev
|
||||
|
||||
Released on 2014-xx-xx.
|
||||
|
||||
- Add a mailing list at Librelist (sigal at librelist.com).
|
||||
- Add an option to specify the port to use for the serve command.
|
||||
- Replace argh with click.
|
||||
- Don't overwrite existing config file (with the init command).
|
||||
- Don't fail if there are no pictures.
|
||||
- Use plain css to simplify theme customizing (no more sass).
|
||||
- Upgrade colorbox 1.5.13
|
||||
- Upgrade galleria 1.4.2
|
||||
- Use HTML5 output for Markdown.
|
||||
- Allow to read additional data for images from markdown files.
|
||||
- Use case insensitive check for file extensions (fix #99).
|
||||
- Add a plugin system with blinker, and make plugins for copyright and adjust.
|
||||
- Mention the irc channel on freenode and add travis notifications.
|
||||
- Avoid failure if GPS tags contain zero values (fix #96).
|
||||
- Remove output file when the ffmpeg process has been interrupted (ref #90).
|
||||
- Fix thumbnail urls to always use slashes (ref #81).
|
||||
|
||||
Version 0.7
|
||||
~~~~~~~~~~~
|
||||
|
||||
|
||||
@@ -5,27 +5,33 @@
|
||||
How to Use
|
||||
~~~~~~~~~~
|
||||
|
||||
Init
|
||||
Initialize
|
||||
To get started, just run ``sigal init`` which will copy an example
|
||||
:doc:`configuration file <configuration>` in the current directory. 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.
|
||||
:doc:`configuration file <configuration>` in the current directory.
|
||||
|
||||
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.
|
||||
|
||||
Build
|
||||
After adapting the configuration to your needs, put your images in
|
||||
a sub-directory and run ``sigal build <your images directory>``. The next
|
||||
time you run ``sigal build``, only the new images will be processed. Use the
|
||||
``-f`` flag to force the reprocessing of all the images. Images (resp.
|
||||
videos) that are smaller than the size specified by the ``img_size`` (resp.
|
||||
``video_size``) setting will not be resized.
|
||||
a sub-directory and run ``sigal build <your images directory>``.
|
||||
|
||||
The next time you run ``sigal build``, only the new images will be processed.
|
||||
You can use the ``-f`` flag to force the reprocessing of all the images.
|
||||
Images (resp. videos) that are smaller than the size specified by the
|
||||
``img_size`` (resp. ``video_size``) setting will not be resized.
|
||||
|
||||
You may also want to know how to specify information about :doc:`albums
|
||||
<album_information>` and :doc:`images <image_information>`.
|
||||
|
||||
Serve
|
||||
To visualize your gallery, you can use ``sigal serve`` which runs a basic
|
||||
web server. This server should only be used for local browsing, not in
|
||||
production. Another option is to use the ``index_in_url = True`` setting,
|
||||
which will add ``index.html`` to the urls to allow browsing without a
|
||||
server.
|
||||
production.
|
||||
|
||||
Another option is to use the ``index_in_url = True`` setting, which will add
|
||||
``index.html`` to the urls to allow browsing without a server.
|
||||
|
||||
|
||||
Help of the ``sigal build`` command
|
||||
|
||||
@@ -43,6 +43,9 @@ You can use the following variables in your template:
|
||||
``theme.name``, ``theme.url``
|
||||
Name and url of the currently used theme.
|
||||
|
||||
Documentation of sigal's main classes
|
||||
-------------------------------------
|
||||
|
||||
.. autoclass:: sigal.gallery.Album
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
||||
Reference in New Issue
Block a user