From 9df639b4036125d9d08612ccf32690c438a4e0e1 Mon Sep 17 00:00:00 2001 From: Justin Mayer Date: Tue, 31 Jul 2012 11:51:38 -0700 Subject: [PATCH] Settings docs: some values need quotes, some don't 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. --- docs/settings.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/settings.rst b/docs/settings.rst index 2d45d463..65c13169 100644 --- a/docs/settings.rst +++ b/docs/settings.rst @@ -11,7 +11,10 @@ example by looking at `/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.