Configuration¶

The extension provides the following configuration:

recentupdate_count¶

Type:: int
Default:: 5

Number of recent revisions to return by default.

recentupdate_template¶

Type:: str

Default:

{% for r in revisions %}
``👤 {{ r.author }}`` @ ``📅 {{ r.date.strftime('%Y-%m-%d') }}``
   ::

      {{ r.message[0] }}

   {% if r.changed_docs -%}
   - Modified {{ r.changed_docs | roles("doc") | join(", ") }}
   {% endif %}
   {% if r.added_docs -%}
   - Added {{ r.added_docs | roles("doc") | join(", ") }}
   {% endif %}
   {% if r.removed_docs -%}
   - Deleted {{ r.removed_docs | join(", ") }}
   {% endif %}
{% endfor %}

Default Jinja2 template for the recentupdate directive. Used when the directive has no body content. The template context contains revisions, a list of Revision objects.

recentupdate_skip_commit¶

Type:: list[str]
Default:: ['skip-recentupdate']

A list of commit message pattern that should be skipped when looking for file changes.

recentupdate_group_by¶

Type:: 'commit', 'day', 'month', 'year'
Default:: 'commit'

Group revisions by time period. When set, revisions are grouped by UTC time period and author. Defaults to commit, which means each commit is shown separately.