documenteer 2.3.0__tar.gz → 2.4.1__tar.gz

{documenteer-2.3.0 → documenteer-2.4.1}/.github/workflows/ci-cron.yaml

@@ -16,14 +16,14 @@ jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
 
       - name: Set up Python
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: ${{ env.PYTHON_VERSION }}
 
-      - uses: actions/setup-node@v4
+      - uses: actions/setup-node@v6
         with:
           cache: 'npm'
           node-version-file: '.nvmrc'
@@ -71,11 +71,11 @@ jobs:
           - "dev"
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
         with:
           fetch-depth: 0 # full history for setuptools_scm
 
-      - uses: actions/setup-node@v4
+      - uses: actions/setup-node@v6
         with:
           node-version-file: '.nvmrc'
 
@@ -115,11 +115,11 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
         with:
           fetch-depth: 0 # full history for setuptools_scm
 
-      - uses: actions/setup-node@v4
+      - uses: actions/setup-node@v6
         with:
           cache: 'npm'
           node-version-file: '.nvmrc'
@@ -160,11 +160,11 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
         with:
           fetch-depth: 0 # full history for setuptools_scm
 
-      - uses: actions/setup-node@v4
+      - uses: actions/setup-node@v6
         with:
           node-version-file: '.nvmrc'
 

{documenteer-2.3.0 → documenteer-2.4.1}/.github/workflows/ci.yaml

@@ -22,14 +22,14 @@ jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
 
       - name: Set up Python
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: ${{ env.PYTHON_VERSION }}
 
-      - uses: actions/setup-node@v4
+      - uses: actions/setup-node@v6
         with:
           cache: 'npm'
           node-version-file: '.nvmrc'
@@ -65,11 +65,11 @@ jobs:
           - '8'
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
         with:
           fetch-depth: 0 # full history for setuptools_scm
 
-      - uses: actions/setup-node@v4
+      - uses: actions/setup-node@v6
         with:
           cache: 'npm'
           node-version-file: '.nvmrc'
@@ -99,14 +99,14 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
         with:
           fetch-depth: 0 # full history for setuptools_scm
 
       - name: Setup Graphviz
         uses: ts-graphviz/setup-graphviz@v2
 
-      - uses: actions/setup-node@v4
+      - uses: actions/setup-node@v6
         with:
           cache: 'npm'
           node-version-file: '.nvmrc'
@@ -148,11 +148,11 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
         with:
           fetch-depth: 0 # full history for setuptools_scm
 
-      - uses: actions/setup-node@v4
+      - uses: actions/setup-node@v6
         with:
           cache: 'npm'
           node-version-file: '.nvmrc'
@@ -185,11 +185,11 @@ jobs:
     if: github.event_name == 'release' && github.event.action == 'published'
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
         with:
           fetch-depth: 0 # full history for setuptools_scm
 
-      - uses: actions/setup-node@v4
+      - uses: actions/setup-node@v6
         with:
           cache: 'npm'
           node-version-file: '.nvmrc'

{documenteer-2.3.0 → documenteer-2.4.1}/CHANGELOG.md

@@ -2,6 +2,23 @@
 
 <!-- scriv-insert-here -->
 
+<a id='changelog-2.4.0'></a>
+## 2.4.0 (2026-06-17)
+
+### New features
+
+- User guide pages now show a "This page was last modified on <date>." timestamp at the bottom of each page, derived from the page's Git commit history. The date is the most recent commit across the page's own source file and any files it pulls in via `include`/`literalinclude`, so editing an included snippet updates every page that uses it. This is on by default and can be disabled with `show_last_updated = false` in the `[sphinx.theme]` table of `documenteer.toml`.
+
+  The footer date is rendered as a `<time>` element whose `datetime` attribute carries the canonical UTC ISO 8601 timestamp, and a small bundled script (`rubin-last-modified.js`) rewrites the visible text to the reader's own local date (for example "June 1, 2024"). With JavaScript disabled the element falls back to the UTC date as `YYYY-MM-DD`. This ensures readers in any timezone see the correct calendar day, which a fixed UTC date can otherwise misrepresent.
+
+  The extension is also the single source of truth for the page's last-modified date in the HTML `<head>`: it emits the same Git date as an `article:modified_time` (Open Graph), `dcterms.modified` (Dublin Core), and a Schema.org `dateModified` (JSON-LD). The user-guide preset sets `git_last_updated_metatags = false` so the auto-loaded `sphinx-last-updated-by-git` extension (still used for the sitemap) doesn't emit a duplicate Open Graph tag from a separate Git computation.
+
+  Because the date comes from Git, CI builds must check out the full history (set `fetch-depth: 0` with `actions/checkout`). To avoid publishing misleading dates, Documenteer detects a shallow clone, omits the timestamp from every page, and emits a build warning.
+
+### Other changes
+
+- Fixed pytest configuration in `pyproject.toml` by consolidating conflicting `[tool.pytest]` and `[tool.pytest.ini_options]` sections into a single `[tool.pytest.ini_options]` section. This resolves an error that prevented tests from running.
+
 <a id='changelog-2.3.0'></a>
 ## 2.3.0 (2025-09-03)
 

{documenteer-2.3.0 → documenteer-2.4.1}/Makefile

@@ -9,7 +9,7 @@ help:
 init:
 	rm -rf .tox
 	uv pip install --upgrade pre-commit tox tox-uv scriv
-	uv pip install -e ".[technote,pipelines]" --group dev
+	uv pip install -e ".[technote,guide]" --group dev
 	pre-commit install
 
 .PHONY: clean

{documenteer-2.3.0/src/documenteer.egg-info → documenteer-2.4.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: documenteer
-Version: 2.3.0
+Version: 2.4.1
 Summary: Rubin Observatory / LSST Sphinx documentation tools, extensions, and configurations.
 License-Expression: MIT
 Project-URL: Homepage, https://documenteer.lsst.io

documenteer-2.4.1/changelog.d/20260727_000000_jonathan_DM_55634_github_edit_link_path.md

@@ -0,0 +1,5 @@
+### Bug fixes
+
+- The "Edit on GitHub" button now links to the correct file. The in-repository path is resolved from the Sphinx **source** directory rather than the directory containing `conf.py`, so projects that build with `sphinx-build -c . docs _build/html` (where those two directories differ) no longer produce links that 404. Projects whose source directory is the repository root also no longer get a stray `./` in the URL. This path is computed by a new `documenteer.ext.githubeditlink` extension, which the user-guide preset enables automatically.
+
+- Building a user guide outside a Git checkout — from an sdist, or in a Docker image built without the `.git` directory — no longer fails at configuration time with `InvalidGitRepositoryError`. The "Edit on GitHub" button is omitted instead and the build proceeds, so setting `show_github_edit_link = false` is no longer needed to work around this. Note that such a build still draws a `git.subprocess_error` warning from sphinx-last-updated-by-git (loaded through sphinx-sitemap), so a project that builds with `-W` also needs `suppress_warnings = ["git.subprocess_error"]` in `conf.py`.

{documenteer-2.3.0 → documenteer-2.4.1}/docs/changelog.md

@@ -2,6 +2,23 @@
 
 <!-- scriv-insert-here -->
 
+<a id='changelog-2.4.0'></a>
+## 2.4.0 (2026-06-17)
+
+### New features
+
+- User guide pages now show a "This page was last modified on <date>." timestamp at the bottom of each page, derived from the page's Git commit history. The date is the most recent commit across the page's own source file and any files it pulls in via `include`/`literalinclude`, so editing an included snippet updates every page that uses it. This is on by default and can be disabled with `show_last_updated = false` in the `[sphinx.theme]` table of `documenteer.toml`.
+
+  The footer date is rendered as a `<time>` element whose `datetime` attribute carries the canonical UTC ISO 8601 timestamp, and a small bundled script (`rubin-last-modified.js`) rewrites the visible text to the reader's own local date (for example "June 1, 2024"). With JavaScript disabled the element falls back to the UTC date as `YYYY-MM-DD`. This ensures readers in any timezone see the correct calendar day, which a fixed UTC date can otherwise misrepresent.
+
+  The extension is also the single source of truth for the page's last-modified date in the HTML `<head>`: it emits the same Git date as an `article:modified_time` (Open Graph), `dcterms.modified` (Dublin Core), and a Schema.org `dateModified` (JSON-LD). The user-guide preset sets `git_last_updated_metatags = false` so the auto-loaded `sphinx-last-updated-by-git` extension (still used for the sitemap) doesn't emit a duplicate Open Graph tag from a separate Git computation.
+
+  Because the date comes from Git, CI builds must check out the full history (set `fetch-depth: 0` with `actions/checkout`). To avoid publishing misleading dates, Documenteer detects a shallow clone, omits the timestamp from every page, and emits a build warning.
+
+### Other changes
+
+- Fixed pytest configuration in `pyproject.toml` by consolidating conflicting `[tool.pytest]` and `[tool.pytest.ini_options]` sections into a single `[tool.pytest.ini_options]` section. This resolves an error that prevented tests from running.
+
 <a id='changelog-2.3.0'></a>
 ## 2.3.0 (2025-09-03)
 

{documenteer-2.3.0 → documenteer-2.4.1}/docs/dev/api/documenteer.ext.rst

@@ -11,6 +11,9 @@ documenteer.ext
 .. automodapi:: documenteer.ext.jira
    :no-inheritance-diagram:
 
+.. automodapi:: documenteer.ext.lastmodified
+   :no-inheritance-diagram:
+
 .. automodapi:: documenteer.ext.lsstdocushare
    :no-inheritance-diagram:
 

{documenteer-2.3.0 → documenteer-2.4.1}/docs/documenteer.toml

@@ -45,7 +45,11 @@ technote = "https://technote.lsst.io/"
 [sphinx.linkcheck]
 ignore = [
     "https://mermaid-js.github.io",
-    "https://rubin-obs.slack.com"
+    "https://rubin-obs.slack.com",
+    "https://slack.com/app_redirect",
+    # github.dev redirects to the vscode.dev SPA, which doesn't finish
+    # loading within linkcheck's timeout and reports a false-positive timeout.
+    "https://github.dev",
 ]
 
 [sphinx.redirects]

{documenteer-2.3.0 → documenteer-2.4.1}/docs/guides/toml-reference.rst

@@ -426,6 +426,58 @@ This configuration requires information about the GitHub repository from these o
 - :ref:`project.github_url <guide-project-github-url>`
 - :ref:`project.github_default_branch <guide-project-github-default-branch>`
 
+.. seealso::
+
+   :doc:`/sphinx-extensions/github-edit-link` for how the edit URL is assembled.
+
+The in-repository path of the documentation is detected automatically from where the Sphinx **source** directory sits in the Git working tree, so there is nothing to configure for it.
+Builds that keep :file:`conf.py` outside the source directory — ``sphinx-build -c . docs _build/html``, for instance — link to the right file.
+
+When the documentation isn't being built from a Git checkout (an sdist, or a Docker image built without the :file:`.git` directory) the path can't be determined, so the button is omitted from every page — noted in the build log at the informational level — and the build proceeds.
+Such a build does still draw a ``git.subprocess_error`` warning from sphinx-last-updated-by-git, so if you build with ``-W`` see :doc:`/sphinx-extensions/github-edit-link` for the warning to suppress.
+To keep the button in that situation, set the path yourself with ``html_context["doc_path"]`` in :file:`conf.py`; see :doc:`/sphinx-extensions/github-edit-link`.
+
+.. _guide-project-show-last-updated:
+
+show_last_updated
+-----------------
+
+|optional|
+
+Default is ``true``, so that each page shows a "Last updated on <date>." timestamp at the bottom of each page.
+
+.. seealso::
+
+   :doc:`/sphinx-extensions/last-updated` for how the date is computed and the extension's
+   Sphinx configuration values.
+
+The date is computed from the page's **Git commit history**, not the filesystem modification time (which is meaningless in CI).
+It is the most recent commit date across the page's own source file *and* any files the page pulls in with ``include`` or ``literalinclude`` directives, so editing an included snippet updates every page that uses it.
+Because the date is the last *commit* date, uncommitted local edits don't change it; a page whose source has never been committed shows no timestamp.
+
+Set this to ``false`` to hide the timestamp:
+
+.. code-block:: toml
+   :caption: documenteer.toml
+
+   [sphinx.theme]
+   show_last_updated = false
+
+.. important::
+
+   Because the date comes from the Git history, your CI build must check out the **full** commit history.
+   With `actions/checkout <https://github.com/actions/checkout>`__, set ``fetch-depth: 0``:
+
+   .. code-block:: yaml
+      :caption: .github/workflows/ci.yaml
+
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+
+   A shallow clone (the default) only fetches the most recent commit, so every page would otherwise report the same, incorrect date.
+   To avoid publishing misleading data, Documenteer detects a shallow clone, **omits the "Last updated" timestamp from every page**, and emits a single build warning telling you to set ``fetch-depth: 0``.
+
 [sphinx.intersphinx]
 ====================
 

documenteer-2.4.1/docs/sphinx-extensions/github-edit-link.rst

@@ -0,0 +1,113 @@
+.. _documenteer-ext-githubeditlink:
+
+######################
+"Edit on GitHub" links
+######################
+
+Documenteer's ``documenteer.ext.githubeditlink`` extension resolves the in-repository path that pydata-sphinx-theme's "Edit on GitHub" button links to.
+It determines where the Sphinx **source** directory sits inside the Git working tree and publishes that path as the ``doc_path`` value in the HTML context.
+
+.. tip::
+
+   If you use Documenteer's user-guide configuration preset, this extension is already enabled and the button is shown by default.
+   Toggle it with the :ref:`show_github_edit_link <guide-project-show-github-edit-link>` setting in :file:`documenteer.toml`; you don't need to edit :file:`conf.py`.
+
+How the edit URL is built
+=========================
+
+pydata-sphinx-theme assembles the edit URL from several HTML context values:
+
+.. code-block:: text
+
+   {github_url}/{github_user}/{github_repo}/edit/{github_version}/{doc_path}{file_name}
+
+The user-guide preset fills in ``github_user``, ``github_repo``, and ``github_version`` from the :ref:`project.github_url <guide-project-github-url>` and :ref:`project.github_default_branch <guide-project-github-default-branch>` settings in :file:`documenteer.toml`.
+
+``file_name`` is supplied by the theme as the page's document name plus its source suffix — for example :file:`index.rst`.
+That name is relative to the Sphinx **source** directory, so ``doc_path`` has to be the source directory's own path within the Git working tree for the two halves to join into a real file path.
+This extension computes that path.
+
+Why an extension rather than :file:`conf.py`
+============================================
+
+The rest of the "Edit on GitHub" context is assembled while :file:`conf.py` is executed, but ``doc_path`` cannot be.
+At that moment there is no Sphinx application yet, and therefore no source directory to consult; the only path available is the current working directory, which Sphinx sets to the directory holding :file:`conf.py` — the *configuration* directory.
+
+For many projects the configuration and source directories are the same, and the distinction doesn't matter.
+They differ whenever a build passes ``-c``:
+
+.. code-block:: shell
+
+   sphinx-build -b html -c . docs _build/html
+
+Here the configuration directory is the repository root while the source directory is :file:`docs/`.
+A ``doc_path`` taken from the configuration directory would produce a URL that looks plausible but points at a file that doesn't exist.
+
+This extension therefore computes ``doc_path`` from the source directory at Sphinx's ``config-inited`` event — the earliest point where the source directory is known.
+That is also the safest point at which to *switch the button off*, because a theme may copy ``html_theme_options`` when the builder initializes, and a change made after that copy wouldn't reach the template.
+
+Overriding the detected path
+============================
+
+Auto-detection covers every layout Rubin projects are known to use, but you can set ``doc_path`` yourself in :file:`conf.py` to override it:
+
+.. code-block:: python
+   :caption: conf.py
+
+   html_context["doc_path"] = "docs"
+
+When ``doc_path`` is already set, the extension uses that value and doesn't consult Git at all.
+The button therefore keeps working outside a Git checkout — supplying the path answers the question that auto-detection would have used the working tree to answer.
+
+This is the escape hatch for source layouts that a path within the working tree can't describe, such as a generated source directory, or documentation published from a different repository than the one being built.
+
+Builds outside a Git checkout
+=============================
+
+The path can only be derived from a Git working tree.
+When the source directory isn't inside one — an sdist, a vendored documentation tree, or a Docker image built without the :file:`.git` directory — the extension omits the "Edit on GitHub" button from every page and notes this in the build log at the informational level.
+
+The message is deliberately *not* a warning: building outside a checkout is legitimate, and a warning would fail any build run with ``-W`` (which turns warnings into errors).
+
+.. note::
+
+   This extension stays quiet, but it isn't the only part of the user-guide stack that reads Git.
+   The preset also loads `sphinx-last-updated-by-git <https://github.com/mgeier/sphinx-last-updated-by-git>`__ (through sphinx-sitemap), which *does* warn when it can't read the history:
+
+   .. code-block:: text
+
+      WARNING: Error getting data from Git (no "last updated" dates will be shown
+      for source files from …): fatal: not a git repository [git.subprocess_error]
+
+   A project that builds with ``-W`` outside a Git checkout therefore needs to suppress that warning as well:
+
+   .. code-block:: python
+      :caption: conf.py
+
+      suppress_warnings = ["git.subprocess_error"]
+
+   Without ``-W`` the warning is harmless and the build succeeds either way.
+
+Reference
+=========
+
+The user-guide configuration preset enables this extension automatically.
+To use it in a standalone Sphinx project, add ``"documenteer.ext.githubeditlink"`` to the extensions list in :file:`conf.py` and provide the repository context that pydata-sphinx-theme expects:
+
+.. code-block:: python
+   :caption: conf.py
+
+   extensions = ["documenteer.ext.githubeditlink", ...]
+
+   html_theme = "pydata_sphinx_theme"
+   html_theme_options = {
+       "use_edit_page_button": True,
+   }
+   html_context = {
+       "github_user": "lsst-sqre",
+       "github_repo": "documenteer",
+       "github_version": "main",
+   }
+
+The extension fills in ``doc_path`` itself, so you don't need to provide it — but it honors the value if you do (see `Overriding the detected path`_).
+It takes no configuration of its own, and is inert unless ``use_edit_page_button`` is enabled.

{documenteer-2.3.0 → documenteer-2.4.1}/docs/sphinx-extensions/index.rst

@@ -19,3 +19,11 @@ Sphinx extensions
 
    remote-code-block
    openapi
+
+.. toctree::
+   :maxdepth: 2
+   :titlesonly:
+   :caption: Page metadata
+
+   last-updated
+   github-edit-link

documenteer-2.4.1/docs/sphinx-extensions/last-updated.rst

@@ -0,0 +1,137 @@
+.. _documenteer-ext-lastmodified:
+
+##############################
+"Last updated" page timestamps
+##############################
+
+Documenteer's ``documenteer.ext.lastmodified`` extension adds a "This page was last modified on <date>." timestamp to the bottom of each page's article body.
+The date is derived from the page's **Git commit history** rather than the filesystem modification time, which is meaningless in CI where checkouts have arbitrary timestamps.
+In the user-guide preset the footer date is rendered to the **reader's** local timezone (see `Reader-localized footer date`_).
+It is also the single source of truth for the page's last-modified date in the HTML ``<head>``, where it emits the same Git date as Open Graph, Dublin Core, and Schema.org metadata (see `HTML metadata`_).
+
+The extension exposes the date to the page template in three forms:
+
+- ``last_updated`` — the date formatted with :ref:`documenteer_last_modified_date_format <documenteer-last-modified-date-format-conf>` in the commit's own timezone offset. Sphinx emits this as the ``docbuild:last-update`` meta tag, and it is the value any theme-agnostic ``last-updated`` rendering uses.
+- ``documenteer_last_modified_iso`` — the canonical UTC ISO 8601 timestamp (for example ``2024-06-01T00:00:00+00:00``).
+- ``documenteer_last_modified_date`` — the UTC date as ``YYYY-MM-DD`` (for example ``2024-06-01``).
+
+Reader-localized footer date
+============================
+
+In the user-guide preset, Documenteer overrides pydata-sphinx-theme's ``last-updated`` component to render the footer date as a ``<time>`` element:
+
+.. code-block:: html
+
+   <time datetime="2024-06-01T00:00:00+00:00">2024-06-01</time>
+
+The ``datetime`` attribute carries the canonical UTC ISO 8601 timestamp, and the visible text is the UTC date as ``YYYY-MM-DD``.
+A small bundled script (``rubin-last-modified.js``) then rewrites the visible text to the **reader's** local date in a long-month style, for example "June 1, 2024".
+This matters because a UTC date can fall on a different calendar day than the reader's local date; localizing in the browser shows each reader the correct day.
+With JavaScript disabled the element keeps its ``YYYY-MM-DD`` UTC fallback text.
+
+.. tip::
+
+   If you use Documenteer's user-guide configuration preset, this extension is already enabled and the timestamp is shown by default.
+   Toggle it with the :ref:`show_last_updated <guide-project-show-last-updated>` setting in :file:`documenteer.toml`; you don't need to edit :file:`conf.py`.
+
+How the date is computed
+========================
+
+The timestamp is the most recent commit date across the page's own source file *and* any files it pulls in with the ``include`` or ``literalinclude`` directives.
+Editing an included snippet therefore updates the timestamp on every page that uses it.
+
+Because the date is the last *commit* date:
+
+- Uncommitted local edits don't change it.
+- A page whose source has never been committed shows no timestamp.
+- Generated pages without a source document (such as the search page and general index) show no timestamp.
+
+HTML metadata
+=============
+
+Besides the visible footer timestamp, the extension writes the **same Git commit date** into the page's HTML ``<head>`` as three machine-readable signals, so that downstream consumers all agree:
+
+- ``<meta property="article:modified_time">`` — the `Open Graph <https://ogp.me/>`__ property used by social-media link previews.
+- ``<meta name="dcterms.modified">`` — the `Dublin Core <https://www.dublincore.org/specifications/dublin-core/dcmi-terms/#modified>`__ modification date.
+- A `Schema.org <https://schema.org/dateModified>`__ ``dateModified`` field inside a JSON-LD ``<script type="application/ld+json">`` block (typed as ``WebPage``).
+
+These three head signals are expressed in **UTC** (ISO 8601, ``+00:00``), so the metadata is identical regardless of the committer's timezone — a locally-authored commit and its UTC-recorded squash-merge produce the same value.
+The visible footer date, by contrast, reflects the commit's own offset.
+
+In addition, pydata-sphinx-theme renders a ``<meta name="docbuild:last-update">`` tag from the same ``last_updated`` context value.
+
+.. note::
+
+   sphinx-sitemap (enabled by the user-guide preset) auto-loads `sphinx-last-updated-by-git <https://github.com/mgeier/sphinx-last-updated-by-git>`__ to populate the sitemap's ``<lastmod>`` entries.
+   That extension runs its *own* Git computation and would otherwise emit a second, potentially divergent ``article:modified_time`` tag.
+   To keep this extension the single source of truth, the user-guide preset sets ``git_last_updated_metatags = False``, which silences the duplicate Open Graph tag while leaving the sitemap behavior intact.
+
+Full Git history is required
+============================
+
+The date comes from Git, so the build must have the **full** commit history.
+
+.. important::
+
+   With `actions/checkout <https://github.com/actions/checkout>`__, set ``fetch-depth: 0``:
+
+   .. code-block:: yaml
+      :caption: .github/workflows/ci.yaml
+
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+
+   A shallow clone (the default) only fetches the most recent commit, so every page would otherwise report the same, incorrect date.
+   To avoid publishing misleading data, Documenteer detects a shallow clone, omits the timestamp from every page, and emits a single build warning.
+
+Reference
+=========
+
+Extension module
+----------------
+
+The user-guide configuration preset enables this extension automatically.
+To use it in a standalone Sphinx project, add ``"documenteer.ext.lastmodified"`` to the extensions list in :file:`conf.py` and render the ``last_updated`` context value.
+With pydata-sphinx-theme, add the ``last-updated`` component to the article footer:
+
+.. code-block:: python
+   :caption: conf.py
+
+   extensions = ["documenteer.ext.lastmodified", ...]
+
+   html_theme = "pydata_sphinx_theme"
+   html_theme_options = {
+       "article_footer_items": ["last-updated"],
+   }
+
+Configurations
+--------------
+
+Set these configurations in the Sphinx :file:`conf.py` file.
+
+.. _documenteer-last-modified-enabled-conf:
+
+documenteer\_last\_modified\_enabled
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Whether to compute and show the "Last updated" timestamp.
+A boolean that defaults to `True`.
+In the user-guide preset this is set automatically from the :ref:`show_last_updated <guide-project-show-last-updated>` field in :file:`documenteer.toml`.
+
+.. _documenteer-last-modified-date-format-conf:
+
+documenteer\_last\_modified\_date\_format
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The ``strftime``-style format string for the ``last_updated`` value.
+Defaults to ``"%b %d, %Y"`` (for example, ``Jun 16, 2026``).
+The date is formatted with Sphinx's date machinery, so it respects the build's ``language`` setting.
+
+This format governs the ``last_updated`` context value — the ``docbuild:last-update`` meta tag and any theme-agnostic ``last-updated`` rendering — **not** the visible footer date in the user-guide preset.
+That footer date is rendered from the UTC ISO timestamp and localized to the reader's timezone by JavaScript (see `Reader-localized footer date`_), so it is not affected by this setting.
+
+.. code-block:: python
+   :caption: conf.py
+
+   documenteer_last_modified_date_format = "%Y-%m-%d"

{documenteer-2.3.0 → documenteer-2.4.1}/pyproject.toml

@@ -163,10 +163,8 @@ exclude_lines = [
     "if TYPE_CHECKING:",
 ]
 
-[tool.pytest]
-norecursedirs = "node_modules"
-
 [tool.pytest.ini_options]
+norecursedirs = "node_modules"
 python_files = ["tests/*.py", "tests/*/*.py"]
 
 [tool.mypy]

documenteer-2.4.1/src/documenteer/assets/rubin-last-modified.js

@@ -0,0 +1,45 @@
+// Localize documenteer.ext.lastmodified's "last modified" footer date.
+//
+// The footer renders the page's Git commit date as a <time> element whose
+// datetime attribute carries the canonical UTC ISO 8601 timestamp and whose
+// visible text is the UTC date (YYYY-MM-DD) as a no-JavaScript fallback. This
+// script rewrites that text to the reader's own local date in a long-month
+// style (for example "June 1, 2024"), so a UTC date that lands on a different
+// calendar day than the reader's is shown correctly for the reader.
+//
+// On any parse failure or invalid date the UTC fallback text is left intact.
+(function () {
+  'use strict';
+
+  function localize() {
+    var elements = document.querySelectorAll(
+      'time[data-documenteer-last-modified]'
+    );
+    for (var i = 0; i < elements.length; i++) {
+      var element = elements[i];
+      var iso = element.getAttribute('datetime');
+      if (!iso) {
+        continue;
+      }
+      try {
+        var date = new Date(iso);
+        if (isNaN(date.getTime())) {
+          continue;
+        }
+        element.textContent = date.toLocaleDateString(undefined, {
+          year: 'numeric',
+          month: 'long',
+          day: 'numeric',
+        });
+      } catch (error) {
+        // Leave the UTC fallback text untouched.
+      }
+    }
+  }
+
+  if (document.readyState === 'loading') {
+    document.addEventListener('DOMContentLoaded', localize);
+  } else {
+    localize();
+  }
+})();

{documenteer-2.3.0 → documenteer-2.4.1}/src/documenteer/assets/rubin-pydata-theme.css

@@ -109,3 +109,25 @@ body {
 .navbar-nav i {
   font-size: var(--pst-font-size-icon);
 }
+
+/* "Last updated" timestamp at the bottom of the article body
+ * (documenteer.ext.lastmodified -> pydata "last-updated" component).
+ * Left-aligned, muted, with breathing room above and below so it reads as
+ * page metadata between the body and the prev/next navigation. */
+.bd-footer-article .last-updated {
+  margin-top: 1.5rem;
+  margin-bottom: 0.5rem;
+  text-align: left;
+  font-size: 0.875em;
+  color: var(--pst-color-text-muted);
+}
+
+/* Indent the footer so the timestamp lines up with the article body text.
+ * pydata-sphinx-theme only indents the article (.bd-article) by 2rem at
+ * >=1200px, so match that breakpoint to avoid over-indenting on narrow
+ * screens, where the body has no extra indent. */
+@media (min-width: 1200px) {
+  .bd-footer-article {
+    padding-left: 2rem;
+  }
+}