diff --git a/docs/faq.rst b/docs/faq.rst index b060108a..735fe9d0 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -93,9 +93,15 @@ Then just make sure to have the template installed in to your theme as What if I want to disable feed generation? ========================================== -To disable all feed generation set ``FEED_ATOM`` and ``FEED_RSS`` to ``None`` in -your settings. Please note ``None`` and ``''`` are not the same thing. The -word ``None`` should not be surrounded by quotes. +To disable all feed generation, all feed settings should be set to ``None``. +Since other feed settings already defaults to ``None``, you only need to set +the following settings:: + + FEED_ALL_ATOM = None + CATEGORY_FEED_ATOM = None + +Please note that ``None`` and ``''`` are not the same thing. The word ``None`` +should not be surrounded by quotes. I'm getting a warning about feeds generated without SITEURL being set properly ============================================================================== @@ -111,18 +117,24 @@ should result in this warning. Feeds are still generated when this warning is displayed but may not validate. -My feeds are broken since I upgraded to Pelican 3.0 +My feeds are broken since I upgraded to Pelican 3.x =================================================== Starting in 3.0, some of the FEED setting names were changed to more explicitly refer to the Atom feeds they inherently represent (much like the FEED_RSS setting names). Here is an exact list of the renamed setting names:: - FEED -> FEED_ALL_ATOM - TRANSLATION_FEED -> TRANSLATION_FEED_ATOM + FEED -> FEED_ATOM TAG_FEED -> TAG_FEED_ATOM CATEGORY_FEED -> CATEGORY_FEED_ATOM +Starting in 3.1, the new feed ``FEED_ALL_ATOM`` has been introduced: this +feed will aggregate all posts regardless of their language. It is generated to +``'feeds/all.atom.xml'`` by default and ``FEED_ATOM`` now defaults to ``None``. +The following FEED setting has also been renamed:: + + TRANSLATION_FEED -> TRANSLATION_FEED_ATOM + Older 2.x themes that referenced the old setting names may not link properly. In order to rectify this, please update your theme for compatibility with 3.0+ by changing the relevant values in your template files. For an example of diff --git a/docs/settings.rst b/docs/settings.rst index eeca4c3a..94ce65a0 100644 --- a/docs/settings.rst +++ b/docs/settings.rst @@ -303,11 +303,15 @@ Setting name (default value) What does it do? to define this (e.g., "http://feeds.example.com"). If you have already explicitly defined SITEURL (see above) and want to use the same domain for your - feeds, you can just set: `FEED_DOMAIN = SITEURL` -`FEED_ATOM` (``'feeds/all.atom.xml'``) Relative URL to output the Atom feed. + feeds, you can just set: ``FEED_DOMAIN = SITEURL``. +`FEED_ATOM` (``None``, i.e. no Atom feed) Relative URL to output the Atom feed. `FEED_RSS` (``None``, i.e. no RSS) Relative URL to output the RSS feed. -`FEED_ALL_ATOM` (``None``, i.e. no all feed) Relative URL to output the all posts Atom feed. -`FEED_ALL_RSS` (``None``, i.e. no all RSS) Relative URL to output the all posts RSS feed. +`FEED_ALL_ATOM` (``'feeds/all.atom.xml'``) Relative URL to output the all posts Atom feed: + this feed will contain all posts regardless of their + language. +`FEED_ALL_RSS` (``None``, i.e. no all RSS) Relative URL to output the all posts RSS feed: + this feed will contain all posts regardless of their + language. `CATEGORY_FEED_ATOM` ('feeds/%s.atom.xml'[2]_) Where to put the category Atom feeds. `CATEGORY_FEED_RSS` (``None``, i.e. no RSS) Where to put the category RSS feeds. `TAG_FEED_ATOM` (``None``, i.e. no tag feed) Relative URL to output the tag Atom feed. It should