Skip to content

chore(deps): update documenteer requirement from >=2.4.0 to >=2.4.1 - #642

Open
dependabot[bot] wants to merge 1 commit into
mainfrom
dependabot/pip/documenteer-gte-2.4.1
Open

chore(deps): update documenteer requirement from >=2.4.0 to >=2.4.1#642
dependabot[bot] wants to merge 1 commit into
mainfrom
dependabot/pip/documenteer-gte-2.4.1

Conversation

@dependabot

@dependabot dependabot Bot commented on behalf of github Aug 1, 2026

Copy link
Copy Markdown
Contributor

Updates the requirements on documenteer to permit the latest version.

Release notes

Sourced from documenteer's releases.

2.4.1

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.

What's Changed

Full Changelog: lsst-sqre/documenteer@2.4.0...2.4.1

Changelog

Sourced from documenteer's changelog.

Change Log

2.4.0 (2026-06-17)

New features

  • User guide pages now show a "This page was last modified on ." 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.

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 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.

2.2.0 (2025-08-06)

New features

  • Updated the documenteer technote migrate command to use Documenteer 2.0 for new technotes.
  • Technote migration documentation now uses uv/uvx for running migration tools.

... (truncated)

Commits
  • 5382a39 Merge pull request #355 from lsst-sqre/tickets/DM-55634-2.4
  • dfb6430 Backport the Edit on GitHub source-directory fix (DM-55634)
  • See full diff in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

  • @dependabot rebase will rebase this PR
  • @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
  • @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
  • @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

@dependabot
chore(deps): update documenteer requirement from >=2.4.0 to >=2.4.1
95e0976 
Updates the requirements on [documenteer](https://github.com/lsst-sqre/documenteer) to permit the latest version.
- [Release notes](https://github.com/lsst-sqre/documenteer/releases)
- [Changelog](https://github.com/lsst-sqre/documenteer/blob/main/CHANGELOG.md)
- [Commits](lsst-sqre/documenteer@2.4.0...2.4.1)

---
updated-dependencies:
- dependency-name: documenteer
  dependency-version: 2.4.1
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot dependabot Bot added dependencies Pull requests that update a dependency file python Pull requests that update python code labels Aug 1, 2026
@changeset-bot

changeset-bot Bot commented Aug 1, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 95e0976

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions github-actions Bot added the dependencies-patch Dependabot semver update type label Aug 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

dependencies Pull requests that update a dependency file dependencies-patch Dependabot semver update type python Pull requests that update python code

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

0 participants