Get the "last updated" time for each Sphinx page from Git
Project description
This is a little Sphinx extension that does exactly that.
It also checks for included files and other dependencies.
If a page doesn’t have a source file, its last_updated time is set to None.
If a source file is not tracked by Git (e.g. because it has been auto-generated on demand by autosummary_generate) but its dependencies are, the last_updated time is taken from them. If you don’t want this to happen, use git_untracked_check_dependencies = False.
If a source file is not tracked by Git, its HTML page doesn’t get a source link. If you do want those pages to have a sourcelink, set git_untracked_show_sourcelink = True. Of course, in this case html_copy_source and html_show_sourcelink must also be True, and the theme you are using must support source links in the first place.
The default value for html_last_updated_fmt is changed from None to the empty string.
- Usage
Install the Python package sphinx-last-updated-by-git
Add 'sphinx_last_updated_by_git' to extensions in your conf.py
Run Sphinx!
- Caveats
Timestamps are stored using the local time zone. If you are running Sphinx on a server that doesn’t happen to be in your desired time zone, you can change it with time.tzset:
import os import time os.environ['TZ'] = 'Europe/Berlin' time.tzset()
When using a “Git shallow clone” (with the --depth option), the “last updated” commit for a long-unchanged file might not have been checked out. In this case, the last_updated time is set to None (and a warning is shown during the build).
This might happen on https://readthedocs.org/ because they use shallow clones by default. The DONT_SHALLOW_CLONE feature should fix this.
If you want to get rid of the warning, use this in your conf.py:
suppress_warnings = ['git.too_shallow']
The date might not be displayed on https://readthedocs.org/ when using the sphinx_rtd_theme (which is their default). See issue #1.
- License
BSD-2-Clause (same as Sphinx itself), for more information take a look at the LICENSE file.
- Similar stuff
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for sphinx-last-updated-by-git-0.2.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4476a92f38a9abc91b25916359061588dd04a4d811382db0a4e818e8356efd0c |
|
MD5 | e5c6ed5f046539e011d785d2e18bae1f |
|
BLAKE2b-256 | 680363d51ce167f3d88b32592e382d37ea2bc91d926cd07160ee59cc632be400 |
Hashes for sphinx_last_updated_by_git-0.2.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e7f24105abba96cc62927f737b2c91171996a8412a3bff6ee00645d33e21dfa3 |
|
MD5 | 0d8420cfd5f3b2b38bece186a3b706f8 |
|
BLAKE2b-256 | 471ace06403d2b436dbbf4dbd432a87e0a8f5eea4d2e581879a6c736def2a98b |