From 6ba7a0926d506ae3c6ce8e085eb7a7a64c9946f2 Mon Sep 17 00:00:00 2001 From: DJ Ramones <50655786+djramones@users.noreply.github.com> Date: Mon, 19 Jun 2023 12:25:32 +0800 Subject: [PATCH] Clarify docs on ordering in period_archives var --- docs/themes.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/themes.rst b/docs/themes.rst index 8e46b716..f68f50c0 100644 --- a/docs/themes.rst +++ b/docs/themes.rst @@ -368,7 +368,8 @@ visible across different site pages. ``period_archives`` is a dict that may contain ``year``, ``month``, and/or ``day`` keys, depending on which ``*_ARCHIVE_SAVE_AS`` settings are enabled. The corresponding value is a list of dicts, where each dict in turn represents -a time period, with the following keys and values: +a time period (ordered according to the ``NEWEST_FIRST_ARCHIVES`` setting) +with the following keys and values: =================== =================================================== Key Value @@ -387,7 +388,8 @@ save_as The path to the save location of the period archive not relevant to themes. articles A list of :ref:`Article ` objects that fall under the time period. -dates Same list as ``articles``, but ordered by date. +dates Same list as ``articles``, but ordered according + to the ``NEWEST_FIRST_ARCHIVES`` setting. =================== =================================================== Here is an example of how ``period_archives`` can be used in a template: