From e43aadd54592f165240775685c08f877ade35643 Mon Sep 17 00:00:00 2001 From: Michael Lissner Date: Thu, 9 Oct 2014 12:23:59 -0700 Subject: [PATCH] Adds more documentation for `--write-selected`. I confess I tried just about every combination of generated file or `md` file before finally getting this right. An example would have helped me tremendously and so I've put an example in here. I also struggled to find this (who looks in settings for details about generation?) so I added a reference from the quickstart page so people can find it more easily in the settings. --- docs/quickstart.rst | 3 +++ docs/settings.rst | 7 +++++++ 2 files changed, 10 insertions(+) diff --git a/docs/quickstart.rst b/docs/quickstart.rst index fb90b002..a13b6e52 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -56,6 +56,9 @@ Your site has now been generated inside the ``output`` directory. (You may see a warning related to feeds, but that is normal when developing locally and can be ignored for now.) +To quickly iterate a single file while working on it, you can generate only a +single file. See: :ref:`writing_only_selected_content`. + Preview your site ----------------- diff --git a/docs/settings.rst b/docs/settings.rst index df2fa722..bc02fc2f 100644 --- a/docs/settings.rst +++ b/docs/settings.rst @@ -811,6 +811,13 @@ on the command line using the ``--write-selected`` option, which accepts a comma-separated list of output file paths. By default this list is empty, so all output is written. +An example of doing this might be: + + pelican --write-selected output/posts/2014/10/08/in-re-nsl/index.html + +You can use the output of the ``--debug`` flag to determine the correct file +names to provide to the ``--write-selected`` flag. + Example settings ================