github/pelican
1
0
Fork 1
mirror of https://github.com/getpelican/pelican.git synced 2025-10-15 20:28:56 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Settings docs: some values need quotes, some don't

Browse source 
Some folks have run into trouble when configuring settings because
they wrap integer values in quotes or forget quotes for string-based
values. Added clarification to docs that will hopefully reduce confusion
in the future.
This commit is contained in:
Justin Mayer 2012-07-31 11:51:38 -07:00
commit 9df639b403
1 changed files with 4 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

5
docs/settings.rst
View file

@ -11,7 +11,10 @@ example by looking at `/samples/pelican.conf.py
<https://github.com/getpelican/pelican/raw/master/samples/pelican.conf.py>`_
All the setting identifiers must be set in all-caps, otherwise they will not be
processed.
processed. Setting values that are numbers (5, 20, etc.), booleans (True,
False, None, etc.), dictionaries, or tuples should *not* be enclosed in
quotation marks. All other values (i.e., strings) *must* be enclosed in
quotation marks.
The settings you define in the configuration file will be passed to the
templates, which allows you to use your settings to add site-wide content.