weeheavy/pelican-theme
1
0
Fork 0
forked from github/pelican
Code Pull requests Activity

Clarify docs re: settings file

Browse source
This commit is contained in:
Justin Mayer 2014-02-07 17:05:15 -08:00
commit 45e1aa112f
1 changed files with 6 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

9
docs/settings.rst
View file

@ -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
<https://github.com/getpelican/pelican/raw/master/samples/pelican.conf.py>`_
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,