diff options
| author | tylerhartley <tyleha@gmail.com> | 2014-09-19 18:45:43 -0700 |
|---|---|---|
| committer | Justin Mayer <entroP@gmail.com> | 2014-09-30 10:40:26 -0700 |
| commit | 693ad3296cc86915002bb86edc8dc08b714ed46e (patch) | |
| tree | d4e4d67bc9c3ed4835c9eb6f6acb9f83790fce30 | |
| parent | c7b52bc730e3f6bde9227b1185e0b841c3ef32e1 (diff) | |
| download | pelican-693ad3296cc86915002bb86edc8dc08b714ed46e.tar.gz | |
EXTRA_PATH_METADATA path separator is OS-specific
Updating docs for EXTRA_PATH_METADATA to clarify that OS-specific path
separators must be used as keys, unlike some other Pelican variables.
Refs # 1133.
| -rw-r--r-- | docs/settings.rst | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/settings.rst b/docs/settings.rst index bd29a409..7a3f08e6 100644 --- a/docs/settings.rst +++ b/docs/settings.rst @@ -74,7 +74,9 @@ Setting name (followed by default value, if any) ``PATH_METADATA = ''`` Like ``FILENAME_METADATA``, but parsed from a page's full path relative to the content source directory. See :ref:`path_metadata`. -``EXTRA_PATH_METADATA = {}`` Extra metadata dictionaries keyed by relative path. +``EXTRA_PATH_METADATA = {}`` Extra metadata dictionaries keyed by relative path. Relative paths + require correct OS-specific directory separators (i.e. / in UNIX and + \\ in Windows) unlike some other Pelican file settings. See :ref:`path_metadata`. ``DELETE_OUTPUT_DIRECTORY = False`` Delete the output directory, and **all** of its contents, before generating new files. This can be useful in preventing older, |