From 45e1aa112fa9ffb12bf6eaa487b41997d5a68ebc Mon Sep 17 00:00:00 2001 From: Justin Mayer Date: Fri, 7 Feb 2014 17:05:15 -0800 Subject: [PATCH] Clarify docs re: settings file --- docs/settings.rst | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/settings.rst b/docs/settings.rst index 9371b8ed..d4d5d073 100644 --- a/docs/settings.rst +++ b/docs/settings.rst @@ -4,11 +4,14 @@ Settings Pelican is configurable thanks to a configuration file you can pass to the command line:: - $ pelican -s path/to/your/settingsfile.py path + $ pelican content -s path/to/your/settingsfile.py -Settings are configured in the form of a Python module (a file). You can see an -example by looking at `/samples/pelican.conf.py +(If you used the `pelican-quickstart` command, your primary settings file will be named `pelicanconf.py` by default.) + +Settings are configured in the form of a Python module (a file). There is an +`example settings file `_ +available for reference. All the setting identifiers must be set in all-caps, otherwise they will not be processed. Setting values that are numbers (5, 20, etc.), booleans (True,