documenteer 2.2.0__tar.gz → 2.4.0__tar.gz

documenteer-2.4.0/.claude/.gitignore

@@ -0,0 +1,2 @@
+settings.local.json
+tasks/*.md

{documenteer-2.2.0 → documenteer-2.4.0}/.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.2.0 → documenteer-2.4.0}/.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.2.0 → documenteer-2.4.0}/CHANGELOG.md

@@ -2,6 +2,45 @@
 
 <!-- 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)
+
+### New features
+
+- Improved configuration defaults for `documenteer.conf.guide` and `documenteer.conf.technote`:
+
+  - Add `sentry_sdk` to default non-intersphinx packages
+  - Ignore `TypeAliasType` due to sphinx bug
+  - Ignore `asyncio.Event`, it has the same problem as `asyncio.Lock`
+
+- [ASCL](https://ascl.net) identifiers in bibliography entries are now hyperlinked.
+
+### Bug fixes
+
+- Vendored `parse_line_num_spec` from Sphinx to accommodate differences between Sphinx 7 and 8.
+- Fix `nitpick_ignore_regex` regexes, they weren't being applied due to a missing `.`
+
+### Other changes
+
+- Added documentation on creating bibliographies in technotes.
+
 <a id='changelog-2.2.0'></a>
 ## 2.2.0 (2025-08-06)
 

documenteer-2.4.0/CLAUDE.md

@@ -0,0 +1,98 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project Overview
+
+Documenteer is a Python package that provides Sphinx documentation tools, extensions, and configurations for Rubin Observatory/LSST projects. It supports two main documentation types:
+- **User guides**: Complete documentation sites using pydata-sphinx-theme
+- **Technotes**: Single-document technical notes using the technote theme
+
+## Development Commands
+
+### Setup and Installation
+```bash
+make init                    # Initialize development environment
+pip install -e ".[technote,guide]" --group dev  # Install with all extras
+```
+
+### Testing and Quality Assurance
+```bash
+tox -e py-test-sphinx8      # Run tests with Sphinx 8.x
+tox -e coverage-report      # Generate coverage report
+tox -e typing-sphinx8       # Run mypy type checking
+tox -e lint                 # Run linting (pre-commit hooks + prettier)
+tox -e demo                 # Build demo technote projects (end-to-end test)
+tox -e packaging            # Check PyPI packaging
+```
+
+### Documentation
+```bash
+tox -e docs                 # Build documentation
+tox -e docs-lint            # Check documentation links
+```
+
+### Cleanup
+```bash
+make clean                  # Remove build artifacts
+```
+
+## Architecture
+
+### Core Components
+
+**Configuration System** (`src/documenteer/conf/`):
+- `guide.py`: Sphinx configuration preset for user guides
+- `technote.py`: Sphinx configuration preset for technotes
+- `_toml.py`: TOML-based configuration models using Pydantic
+- Uses pydata-sphinx-theme for guides, [technote](https://github.com/lsst-sqre/technote) package for technotes
+
+**Sphinx Extensions** (`src/documenteer/ext/`):
+- `jira.py`: JIRA ticket references
+- `lsstdocushare.py`: LSST DocuShare document links
+- `openapi.py`: OpenAPI documentation integration
+- `githubbibcache.py`: GitHub-based bibliography caching
+- `bibtex.py`: Enhanced BibTeX support
+- `remotecodeblock.py`: Remote code inclusion
+- `mockcoderefs.py`: Mock code references for testing
+- `redoc.py`: Redoc integration for HTTP API documentation
+- `robots.py`: robots.txt generation
+
+**CLI Tools** (`src/documenteer/cli.py`):
+- `technote add-author`: Add authors to technote.toml from authordb
+- `technote sync-authors`: Sync author info from central database
+- `technote migrate`: Migrate legacy technotes to modern format
+
+**Services** (`src/documenteer/services/`):
+- `technoteauthor.py`: Author management for technotes
+- `technotemigration.py`: Legacy technote migration logic
+
+### Key Design Patterns
+
+- **Configuration as Code**: Sphinx configurations are Python modules that can be imported
+- **Pydantic Models**: TOML configuration validation using type-safe models
+- **Extension Architecture**: Modular Sphinx extensions for specific Rubin/LSST needs
+- **Theme Integration**: Tight integration with pydata-sphinx-theme and technote themes
+
+### Testing Strategy
+
+- Uses tox for multi-environment testing across Sphinx versions
+- Sphinx test roots in `tests/roots/` for extension testing
+- Coverage reporting with branch coverage
+- Type checking with mypy
+- Pre-commit hooks for code quality
+
+### Code Style
+
+- Follows ruff formatting (run lint command to automatically format)
+- Numpydoc docstrings with types omitted (Sphinx documentation uses type annotations)
+
+### Asset Management
+
+Static assets are managed in `src/documenteer/assets/` including:
+- Custom CSS and SCSS for Rubin branding
+- JavaScript enhancements
+- Favicon and logo assets
+- Font files (Source Sans Pro)
+
+Built assets are compiled using webpack with PostCSS processing.

{documenteer-2.2.0 → documenteer-2.4.0}/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.2.0 → documenteer-2.4.0}/PKG-INFO

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

{documenteer-2.2.0 → documenteer-2.4.0}/demo/rst-technote/index.rst

@@ -29,7 +29,7 @@ A list:
 - Second item
 - Third item
 
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin facilisis pharetra neque, at semper nulla mattis auctor. Proin semper mollis enim eget interdum. Mauris eleifend eget diam vitae bibendum. Praesent ut aliquet odio, sodales imperdiet nisi. Nam interdum imperdiet tortor sed fringilla. Maecenas efficitur mi sodales nulla commodo rutrum. Ut ornare diam quam, sed commodo turpis aliquam et. In nec enim consequat, suscipit tortor sit amet, luctus ante. Integer dictum augue diam, non pulvinar massa euismod in. Morbi viverra condimentum auctor. Nullam et metus mauris. Cras risus ex, porta sit amet nibh et, dapibus auctor leo.
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin facilisis pharetra neque, at semper nulla mattis auctor. Proin semper mollis enim eget interdum. Mauris eleifend eget diam vitae bibendum. Praesent ut aliquet odio, sodales imperdiet nisi. Nam interdum imperdiet tortor sed fringilla. Maecenas efficitur mi sodales nulla commodo rutrum. Ut ornare diam quam, sed commodo turpis aliquam et. In nec enim consequat, suscipit tortor sit amet, luctus ante. Integer dictum augue diam, non pulvinar massa euismod in. Morbi viverra condimentum auctor. Nullam et metus mauris. Cras risus ex, porta sit amet nibh et, dapibus auctor leo. :cite:`2010ascl.soft10043C`
 
 .. code-block:: python
    :caption: hello.py

documenteer-2.4.0/demo/rst-technote/local.bib

@@ -0,0 +1,10 @@
+@software{2010ascl.soft10043C,
+       author = {{Conroy}, Charlie and {Gunn}, James E.},
+        title = "{FSPS: Flexible Stellar Population Synthesis}",
+ howpublished = {Astrophysics Source Code Library, record ascl:1010.043},
+         year = 2010,
+        month = oct,
+          eid = {ascl:1010.043},
+       adsurl = {https://ui.adsabs.harvard.edu/abs/2010ascl.soft10043C},
+      adsnote = {Provided by the SAO/NASA Astrophysics Data System}
+}

{documenteer-2.2.0 → documenteer-2.4.0}/docs/changelog.md

@@ -2,6 +2,45 @@
 
 <!-- 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)
+
+### New features
+
+- Improved configuration defaults for `documenteer.conf.guide` and `documenteer.conf.technote`:
+
+  - Add `sentry_sdk` to default non-intersphinx packages
+  - Ignore `TypeAliasType` due to sphinx bug
+  - Ignore `asyncio.Event`, it has the same problem as `asyncio.Lock`
+
+- [ASCL](https://ascl.net) identifiers in bibliography entries are now hyperlinked.
+
+### Bug fixes
+
+- Vendored `parse_line_num_spec` from Sphinx to accommodate differences between Sphinx 7 and 8.
+- Fix `nitpick_ignore_regex` regexes, they weren't being applied due to a missing `.`
+
+### Other changes
+
+- Added documentation on creating bibliographies in technotes.
+
 <a id='changelog-2.2.0'></a>
 ## 2.2.0 (2025-08-06)
 

{documenteer-2.2.0 → documenteer-2.4.0}/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.2.0 → documenteer-2.4.0}/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.2.0 → documenteer-2.4.0}/docs/guides/configuration.rst

@@ -18,11 +18,14 @@ How you do this depends on your project's packaging structure:
       .. code-block:: toml
          :caption: pyproject.toml
 
-         [project.optional-dependencies]
-         dev = [
+         [dependency-groups]
+         docs = [
              "documenteer[guide]"
          ]
 
+      Dependency groups are a way organize development dependencies and are supported by `uv <https://docs.astral.sh/uv/concepts/projects/dependencies/#development-dependencies>`__.
+      Dependency groups are preferred over earlier methods of specifying optional dependencies because they are not published as installable dependencies from PyPI.
+
    .. tab-item:: requirements.txt
 
       .. code-block:: text

{documenteer-2.2.0 → documenteer-2.4.0}/docs/guides/toml-reference.rst

@@ -426,6 +426,47 @@ 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>`
 
+.. _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.2.0 → documenteer-2.4.0}/docs/index.rst

@@ -56,15 +56,15 @@ Installation
 
       .. code-block:: sh
 
-         conda install documenteer
+         conda install lsst-documenteer
 
-      To use Documenteer's configurations for specific Rubin documentation use cases, you'll need to install Documenteer with specific "extras" to bring in the necessary dependencies.
-
-      To install Documenteer for technote projects:
+      For user guide projects:
 
       .. code-block:: sh
 
-         conda-install lsst-documenteer-technote
+         conda-install lsst-documenteer-guide
+
+      *Conda distributions aren't available for technote projects at this time.*
 
 Project guides
 ==============

{documenteer-2.2.0 → documenteer-2.4.0}/docs/sphinx-extensions/index.rst

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

documenteer-2.4.0/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.2.0 → documenteer-2.4.0}/docs/technotes/_templates/README.md

@@ -16,7 +16,7 @@ A short description of this document.
 
 ## Build this technical note
 
-You can clone this repository and build the technote locally if your system has Python 3.11 or later:
+You can clone this repository and build the technote locally if your system has Python 3.12 or later:
 
 ```bash
 git clone https://github.com/lsst/example-000

{documenteer-2.2.0 → documenteer-2.4.0}/docs/technotes/_templates/README.rst

@@ -22,7 +22,7 @@ A short description of this document.
 Build this technical note
 =========================
 
-You can clone this repository and build the technote locally if your system has Python 3.11 or later:
+You can clone this repository and build the technote locally if your system has Python 3.12 or later:
 
 .. code-block:: bash