sphinxnotes-recentupdate¶

Introduction¶

Get the Sphinx document update information from Git repository.

This extension integrates with sphinxnotes-render by providing an extra context recentupdate. The recent document update information is read from a Git repository. You can customize the presentation via data.render 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.render.ext',
           'sphinxnotes.recentupdate',
           # …
           ]

Now you can use the data.render directive (provided by sphinxnotes.render.ext) with recentupdate extra context to render a revision list:

Source

.. data.render::

   The most recent 3 commits:

   {% for r in load_extra('recentupdate', 3) %}
   ``{{ r.date }}``
      {{ r.message[0] }}
   {% endfor %}

Result

Please refer to Usage for more details.

Contents¶

Contents

The Sphinx Notes Project¶

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

The Sphinx Notes Project