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

Clarify docs on ordering in period_archives var

Browse source
This commit is contained in:
DJ Ramones 2023-06-19 12:25:32 +08:00
commit 6ba7a0926d
No known key found for this signature in database
GPG key ID: D0EB42161D927EB0
1 changed files with 4 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

6
docs/themes.rst
View file

@ -368,7 +368,8 @@ visible across different site pages.
``period_archives`` is a dict that may contain ``year``, ``month``, and/or ``period_archives`` is a dict that may contain ``year``, ``month``, and/or
``day`` keys, depending on which ``*_ARCHIVE_SAVE_AS`` settings are enabled. ``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 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 Key Value
@ -387,7 +388,8 @@ save_as The path to the save location of the period archive
not relevant to themes. not relevant to themes.
articles A list of :ref:`Article <object-article>` objects articles A list of :ref:`Article <object-article>` objects
that fall under the time period. 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: Here is an example of how ``period_archives`` can be used in a template: