github/pelican
1
0
Fork 1
mirror of https://github.com/getpelican/pelican.git synced 2025-10-15 20:28:56 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

note that {ARTICLE,PAGE}_PATHS may include files, add faq about using that

Browse source
This commit is contained in:
Ondrej Grover 2014-11-04 17:00:01 +01:00
commit 369b8b8474
2 changed files with 13 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

9
docs/faq.rst
View file

@ -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 working on some specific page or the theme templates), the
`WRITE_SELECTED` option may help, see `WRITE_SELECTED` option may help, see
:ref:`writing_only_selected_content`. :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``.

6
docs/settings.rst
View file

@ -125,10 +125,12 @@ Setting name (followed by default value, if any)
``PATH`` Path to content directory to be processed by Pelican. If undefined, ``PATH`` Path to content directory to be processed by Pelican. If undefined,
and content path is not specified via an argument to the ``pelican`` and content path is not specified via an argument to the ``pelican``
command, Pelican will use the current working directory. 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 ``PAGE_EXCLUDES = []`` A list of directories to exclude when looking for pages in addition
to ``ARTICLE_PATHS``. 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 ``ARTICLE_EXCLUDES = []`` A list of directories to exclude when looking for articles in addition
to ``PAGE_PATHS``. to ``PAGE_PATHS``.
``OUTPUT_SOURCES = False`` Set to True if you want to copy the articles and pages in their ``OUTPUT_SOURCES = False`` Set to True if you want to copy the articles and pages in their