From 369b8b84745e60affd48257c9c9ccb914c07eb22 Mon Sep 17 00:00:00 2001 From: Ondrej Grover Date: Tue, 4 Nov 2014 17:00:01 +0100 Subject: [PATCH] note that {ARTICLE,PAGE}_PATHS may include files, add faq about using that --- docs/faq.rst | 9 +++++++++ docs/settings.rst | 6 ++++-- 2 files changed, 13 insertions(+), 2 deletions(-) diff --git a/docs/faq.rst b/docs/faq.rst index 2a931192..c749c262 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -232,3 +232,12 @@ When only several specific output files are of interest (e.g. when working on some specific page or the theme templates), the `WRITE_SELECTED` option may help, see :ref:`writing_only_selected_content`. + +How to process only a subset of all articles? +============================================= + +It is often useful to process only e.g. 10 articles for debugging +purposes. This can be achieved by explicitly specifying only the +filenames of those articles in ``ARTICLE_PATHS``. A list of such +filenames could be found using a command similar to ``cd content; +find -name '*.md' | head -n 10``. diff --git a/docs/settings.rst b/docs/settings.rst index 892ab082..02f4359f 100644 --- a/docs/settings.rst +++ b/docs/settings.rst @@ -125,10 +125,12 @@ Setting name (followed by default value, if any) ``PATH`` Path to content directory to be processed by Pelican. If undefined, and content path is not specified via an argument to the ``pelican`` command, Pelican will use the current working directory. -``PAGE_PATHS = ['pages']`` A list of directories to look at for pages, relative to ``PATH``. +``PAGE_PATHS = ['pages']`` A list of directories and files to look at for pages, + relative to ``PATH``. ``PAGE_EXCLUDES = []`` A list of directories to exclude when looking for pages in addition to ``ARTICLE_PATHS``. -``ARTICLE_PATHS = ['']`` A list of directories to look at for articles, relative to ``PATH``. +``ARTICLE_PATHS = ['']`` A list of directories and files to look at for articles, + relative to ``PATH``. ``ARTICLE_EXCLUDES = []`` A list of directories to exclude when looking for articles in addition to ``PAGE_PATHS``. ``OUTPUT_SOURCES = False`` Set to True if you want to copy the articles and pages in their