sphinxnotes-recentupdate¶

Introduction¶

Get the document update information from git and display it in Sphinx documentation.

This extensions provides a recentupdate directive, which can show recent document update of current Sphinx documentation. The update information is read from Git repository (So you must use Git to manage your documentation). You can customize the update information through generating reStructuredText from Jinja template.

Getting Started¶

Note

We assume you already have a Sphinx documentation, if not, see Getting Started with Sphinx.

First, downloading extension from PyPI:

$ pip install sphinxnotes-recentupdate

Then, add the extension name to extensions configuration item in your conf.py:

extensions = [
          # …
          'sphinxnotes.recentupdate',
          # …
          ]

Add recentupdate directive to your document, build your document, the directive will be rendered to:

reStructuredText

.. recentupdate::

Result

2025-10-30

Author:: Shengyu Zhang
Message:: chore: Bump version to 1.1

Modified Change Log

2025-10-30

Author:: Shengyu Zhang
Message:: chore: Update project template to sphinx-notes/cookiecutter@4736b672

Modified sphinxnotes-recentupdate

2025-10-16

Author:: Shengyu Zhang
Message:: chore: Bump version to 1.0

Modified Change Log

2025-10-16

Author:: Shengyu Zhang
Message:: Merge pull request #3 from sphinx-notes/template

chore: Update project template to sphinx-notes/cookiecutter@800a79a0

Added Change Log, Configuration, sphinxnotes-recentupdate, Usage

Contents¶

Contents

The Sphinx Notes Project¶

The project is developed by Shengyu Zhang, as part of The Sphinx Notes Project.

The Sphinx Notes Project