Skip to content

Comments

Update documenteer[technote] requirement from <2.0,>=1.0 to >=1.0,<3.0#10

Open
dependabot[bot] wants to merge 1 commit intomainfrom
dependabot/pip/documenteer-technote--gte-1.0-and-lt-3.0
Open

Update documenteer[technote] requirement from <2.0,>=1.0 to >=1.0,<3.0#10
dependabot[bot] wants to merge 1 commit intomainfrom
dependabot/pip/documenteer-technote--gte-1.0-and-lt-3.0

Conversation

@dependabot
Copy link

@dependabot dependabot bot commented on behalf of github Dec 8, 2025

Updates the requirements on documenteer[technote] to permit the latest version.

Release notes

Sourced from documenteer[technote]'s releases.

2.3.0

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.

What's Changed

Full Changelog: lsst-sqre/documenteer@2.2.0...2.3.0

Changelog

Sourced from documenteer[technote]'s changelog.

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.

  • Improved the formatting for reference section in technotes with the Rubin BibTeX style:

    • If an entry has more than 7 authors, the first three authors are listed, followed by "and others."
    • LaTeX macros for journals are now converted to their expected names in the bibliography.

Other changes

  • Cleanup the API documentation for cleaner documentation builds.

2.1.1 (2025-07-17)

Bug fixes

  • When adding or updating authors in technote.toml, Documenteer avoids setting null values. TOML represents null values as absent keys, but previous versions of Documenteer included null ror values.

2.1.0 (2025-07-16)

New features

  • Improved and extended the nitpick ignore configurations for both user guides and technotes. The new configuration engine uses a common set of utility functions to generate the ignore patterns. Additionally, Documenteer makes better use of regex patterns to ignore linking issues to APIs that are not documented with Sphinx, such as fastapi, httpx, and pydantic. This should reduce the number of nitpick warnings in user guides and technotes, and generally reduce the need for manual nitpick ignores in projects.

... (truncated)

Commits
  • cfe97f6 Merge pull request #269 from lsst-sqre/u/jonathansick/release
  • 9a7c3c9 Update change log for 2.3.0
  • 50512b0 Merge pull request #265 from lsst-sqre/tickets/DM-52199
  • 8db6f97 Add demo of ascl.net linking
  • 95d936c Add changelog entry for ascl hyperlinking
  • 6c219f1 Add support for ASCL @​software bib entries
  • a4acb10 Merge pull request #268 from lsst-sqre/tickets/DM-52367/more-autodoc-workarounds
  • a398032 scriv entry
  • 01dc1f0 Add more non-intersphinx packages
  • 788ef41 Ignore TypeAliasType due to sphinx bug
  • Additional commits viewable 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 merge will merge this PR after your CI passes on it
  • @dependabot squash and merge will squash and merge this PR after your CI passes on it
  • @dependabot cancel merge will cancel a previously requested merge and block automerging
  • @dependabot reopen will reopen this PR if it is closed
  • @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
  • @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)

Updates the requirements on [documenteer[technote]](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@1.0.0...2.3.0)

---
updated-dependencies:
- dependency-name: documenteer[technote]
  dependency-version: 2.3.0
  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 Dec 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dependencies Pull requests that update a dependency file python Pull requests that update Python code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants