Add warning to docs re: DELETE_OUTPUT_DIRECTORY

This commit is contained in:
Justin Mayer 2013-05-02 17:18:19 -07:00
commit 34f05d4ba6

View file

@ -64,8 +64,10 @@ Setting name (default value) What doe
``'(?P<date>\d{4}-\d{2}-\d{2})_(?P<slug>.*)'``. ``'(?P<date>\d{4}-\d{2}-\d{2})_(?P<slug>.*)'``.
`PATH_METADATA` (``''``) Like ``FILENAME_METADATA``, but parsed from a page's `PATH_METADATA` (``''``) Like ``FILENAME_METADATA``, but parsed from a page's
full path relative to the content source directory. full path relative to the content source directory.
`DELETE_OUTPUT_DIRECTORY` (``False``) Delete the content of the output directory before `DELETE_OUTPUT_DIRECTORY` (``False``) Delete the output directory, and **all** of its contents, before
generating new files. generating new files. This can be useful in preventing older,
unnecessary files from persisting in your output. However, **this is
a destructive setting and should be handled with extreme care.**
`FILES_TO_COPY` (``()``) A list of files (or directories) to copy from the source (inside the `FILES_TO_COPY` (``()``) A list of files (or directories) to copy from the source (inside the
content directory) to the destination (inside the output directory). content directory) to the destination (inside the output directory).
For example: ``(('extra/robots.txt', 'robots.txt'),)``. For example: ``(('extra/robots.txt', 'robots.txt'),)``.