sphinx-last-updated-by-git
Get the "last updated" time for each Sphinx page from Git
Decision gist · record as of 2026-08-14
Yes, if you maintain Sphinx documentation in a Git repository and want automatic, accurate last-updated timestamps without manual configuration. The package is actively maintained, has no vulnerabilities, and integrates seamlessly with Sphinx. Be aware that shallow Git clones (common on Read the Docs by default) will cause some files to show no timestamp—this is documented and has a documented workaround.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Git to be installed and the documentation source to be in a Git repository; shallow clones may cause some files to have no last-updated time.
- Low install friction with a single runtime dependency on Sphinx.
- The package is actively maintained with a recent commit history (last commit 2026-07-20) and no known vulnerabilities, making it straightforward to add to an existing Sphinx setup.
License · maintenance · safety
BSD-2-Clause (permissive) — Licensed under BSD-2-Clause, the same permissive license as Sphinx itself, so there are no licensing constraints on use in commercial or open-source projects.
last release 2024-08-11 (733 days) · last repo commit 2026-07-20 · 60 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 555,428 downloads/mo, #6,026 on PyPI
Alternatives
Verify before relying
pip install sphinx-last-updated-by-git
# In conf.py:
extensions = ['sphinx_last_updated_by_git']
# Then run: sphinx-build -b html source build/html- Whether the extension works correctly with all Sphinx themes or only specific ones (e.g., sphinx_rtd_theme compatibility details).
- Performance impact when processing large documentation projects with many files and dependencies.
What it is and what it does
This is a Sphinx extension that automatically populates the last-updated timestamp for each documentation page by querying Git commit history. Instead of manually setting update dates, the extension inspects the Git author date of the most recent commit that changed each source file, and also checks included files and dependencies to use their timestamp if more recent. The extension respects Git's tracked-file status and can be configured to handle auto-generated files, exclude patterns, and timezone preferences.
The extension integrates directly into Sphinx's build process and requires only that your documentation source is in a Git repository. It handles edge cases like shallow clones (common on Read the Docs and GitHub Actions) by setting the timestamp to None and optionally warning during the build. Configuration options allow you to control dependency checking, source links for untracked files, timezone display, HTML metatag generation, and exclusion patterns for both files and commits.
Use it for
- Display accurate last-modified dates in Sphinx documentation footers without manual maintenance.
- Track which pages in a large documentation project have been recently updated or are stale.
- Automatically include dependency changes (e.g., included snippets or generated content) in page freshness calculations.
- Exclude specific files or commits from affecting the last-updated timestamp for auto-generated or frequently-touched files.
- Configure timezone-aware timestamps for international documentation teams using Babel or Python timezone objects.
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes, if you maintain Sphinx documentation in a Git repository and want automatic, accurate last-updated timestamps without manual configuration.
The package is actively maintained, has no vulnerabilities, and integrates seamlessly with Sphinx. Be aware that shallow Git clones (common on Read the Docs by default) will cause some files to show no timestamp—this is documented and has a documented workaround.
Install
sphinx-last-updated-by-git on PyPI
Before you install
Low install friction with a single runtime dependency on Sphinx. The package is actively maintained with a recent commit history (last commit 2026-07-20) and no known vulnerabilities, making it straightforward to add to an existing Sphinx setup.
Requires Git to be installed and the documentation source to be in a Git repository; shallow clones may cause some files to have no last-updated time.
License in practice
Licensed under BSD-2-Clause, the same permissive license as Sphinx itself, so there are no licensing constraints on use in commercial or open-source projects.
Quickstart
pip install sphinx-last-updated-by-git
# In conf.py:
extensions = ['sphinx_last_updated_by_git']
# Then run: sphinx-build -b html source build/htmlVerify before relying
- Whether the extension works correctly with all Sphinx themes or only specific ones (e.g., sphinx_rtd_theme compatibility details).
- Performance impact when processing large documentation projects with many files and dependencies.
Package facts
| License | BSD-2-Clause permissive |
| Python support | Supports the current Python release >=3.7 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 1 packagesphinx |
| Maintenance | Actively maintained 733 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 555,428 / month, #6,026 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Framework :: SphinxFramework :: Sphinx :: ExtensionLicense :: OSI Approved :: BSD LicenseOperating System :: OS IndependentProgramming Language :: PythonProgramming Language :: Python :: 3Topic :: Documentation :: Sphinx |
Evidence: sphinx_last_updated_by_git-0.3.8-py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “sphinx last updated git”
- sphinx-last-updated-by-gitA Sphinx extension that automatically extracts and displays the…
- mkdocs-git-revision-date-localized-pluginA MkDocs plugin that displays the date of the last git modification…
- mkdocs-git-revision-date-pluginAdds a Git-based revision date to MkDocs documentation pages,…
Give your agent the search over MCP, or paste the wish link into any chat.
More Sphinx packages
Parses Python docstrings in ReST, Google, Numpydoc, and Epydoc formats, extracting structured information like descriptions, parameters, return types, and exceptions.
Install it if you need to programmatically read and extract structured data from Python docstrings.
Sphinx generates professional documentation from reStructuredText source files, producing HTML, PDF, EPUB, and other formats with automatic cross-references, code highlighting, and hierarchical navigation.
A Sphinx extension that outputs documentation in serialized HTML formats (JSON and pickle) alongside standard HTML.
Alabaster is a clean, responsive Sphinx theme for documentation that requires Python 3.10 or newer and Sphinx 6.2 or newer.
A Sphinx extension that generates HTML help files from reStructuredText documentation source.
A Sphinx extension that converts documentation source files into QtHelp format, enabling integration with Qt-based help systems and documentation viewers.
However, be aware that maintenance is dormant—if you rely on it long-term, monitor Sphinx compatibility and consider whether QtHelp remains the right format for your…
See also readthedocs-sphinx-search · sphinx-click · sphinxcontrib-googleanalytics · sphinx-issues · autodocsumm · sphinx-reredirects · sphinx-notfound-page · mkdocs-git-revision-date-localized-plugin · sphinx-press-theme · sphinxext-rediraffe