Usage

The extension provides an extra context recentupdate usable via load_extra function in sphinxnotes-render template:

Source

.. data.render::

   {% for r in load_extra('recentupdate', 3) %}
   ``📅 {{ r.date }}`` | ``👤{{ r.author }}``

     {{ 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 %}

Result

System Message: ERROR/2 (<generated text>, line 36)

Render Report:

Failed to render Jinja template:

extra_context_loader.<locals>.load_extra() takes 1 positional argument but 2 were given

The load_extra('recentupdate', count=3) returns a list of Revision objects from recent Git commits that touched document files, see below.

The roles filter is provided by sphinxnotes-render too.

See also

sphinxnotes-render: Templating

How to write data.render templates.

sphinxnotes-render: Templating

How extra context and filters work.

The “recentupdate” extra context

load_extra('recentupdate', count=3) returns a list of Revision objects from recent Git commits that touched document files.

• count (int) — Number of recent revisions to return (default 10).

class sphinxnotes.recentupdate.Revision

Revision.message: list[str]

Git commit message, split by lines

Revision.author: str

Git commit author

Revision.date: datetime

Git commit author date

Revision.added_docs: list[str]

List of docname, corresponding to files which are newly added

Revision.changed_docs: list[str]

List of docname, corresponding to files which are modified

Revision.removed_docs: list[str]

List of docname, corresponding to files which are deleted