Skip to content

Update Documenter requirement to 1.17.0 in /docs#2

Open
dependabot[bot] wants to merge 1 commit into
mainfrom
dependabot/julia/docs/Documenter-1.17.0
Open

Update Documenter requirement to 1.17.0 in /docs#2
dependabot[bot] wants to merge 1 commit into
mainfrom
dependabot/julia/docs/Documenter-1.17.0

Conversation

@dependabot
Copy link
Copy Markdown

@dependabot dependabot Bot commented on behalf of github May 31, 2026

Updates the requirements on Documenter to permit the latest version.

Release notes

Sourced from Documenter's releases.

v1.17.0

Added

  • The version selector now also preserves the anchor (hash) when switching between documentation versions. Additionally, the outdated/dev version warning banner now also tries to keep you on the same page (and position) when linking to the latest stable release. (#2880)
  • Added Remotes.Forgejo for specifying a Remote hosted on a Forgejo instance (such as codeberg.org). (#2857)
  • Doctests now default to the parser_for_module of the module that the docstring appears in, allowing modules that set their syntax version via Base.Experimental.@set_syntax_version to have their doctests parsed with the correct syntax automatically. Also added support for DocTestSyntax metadata and per-block syntax= attributes to explicitly specify a syntax version. (#2874)
  • Added a show_log keyword for Documenter.LaTeX to print LaTeX compiler logs to stdout when PDF compilation fails, and support for forcing this via DOCUMENTER_LATEX_SHOW_LOGS in CI environments. (#1697)
  • Added support for new features of the Markdown stdlib introduced in Julia 1.14, namely strike through, HTML blocks and inline HTML (this requires Julia 1.14+ and MarkdownAST 0.1.3).

Changed

  • reduced time complexity from O(n^2) to O(n) to improve the initial load time for search (#2875)
  • Git no longer displays a message about the default branch name when calling deploydocs(). (#2854)
  • Don't escape characters (such as ~) in URLs when writing LaTeX. (#2210)
  • Tweak the layout of the table of contents in LaTeX / PDF output so that for a document with 8 or more parts, the part number (VIII) does not overlap with the part title. (#2871)

Fixed

  • Fixed rendering of operator docstring bindings such as Base.:(:) and Base.:(==) in doc headers and indices. (#2844)

The changes are documented in the CHANGELOG.md file.

Diff since v1.16.1

Changelog

Sourced from Documenter's changelog.

Version [v1.17.0] - 2026-02-20

Added

  • The version selector now also preserves the anchor (hash) when switching between documentation versions. Additionally, the outdated/dev version warning banner now also tries to keep you on the same page (and position) when linking to the latest stable release. (#2880)
  • Added Remotes.Forgejo for specifying a Remote hosted on a Forgejo instance (such as codeberg.org). (#2857)
  • Doctests now default to the parser_for_module of the module that the docstring appears in, allowing modules that set their syntax version via Base.Experimental.@set_syntax_version to have their doctests parsed with the correct syntax automatically. Also added support for DocTestSyntax metadata and per-block syntax= attributes to explicitly specify a syntax version. (#2874)
  • Added a show_log keyword for Documenter.LaTeX to print LaTeX compiler logs to stdout when PDF compilation fails, and support for forcing this via DOCUMENTER_LATEX_SHOW_LOGS in CI environments. (#1697)
  • Added support for new features of the Markdown stdlib introduced in Julia 1.14, namely strike through, HTML blocks and inline HTML (this requires Julia 1.14+ and MarkdownAST 0.1.3).

Changed

  • reduced time complexity from O(n^2) to O(n) to improve the initial load time for search (#2875)
  • Git no longer displays a message about the default branch name when calling deploydocs(). (#2854)
  • Don't escape characters (such as ~) in URLs when writing LaTeX. (#2210)
  • Tweak the layout of the table of contents in LaTeX / PDF output so that for a document with 8 or more parts, the part number (VIII) does not overlap with the part title. (#2871)

Fixed

  • During cross-referencing find_object correctly locates the Documenter.Object associated with UnionAll method signatures. (#2836, #2889)
  • Fixed rendering of operator docstring bindings such as Base.:(:) and Base.:(==) in doc headers and indices. (#2844)

Version [v1.16.1] - 2025-11-21

Fixed

  • The -g is now passed to curl when checking links, to disable globbing, which could cause undesirable behavior when checking links containing characters like for example [, {, & or ?. (#2839, #2842)
  • Fixed insufficient paragraph spacing in HTML output for @docs blocks. ([#2845, #2847])
  • Don't expand details admonition by default. ([#2846, #2847])
  • Removed superfluous vertical space at end of @docs blocks. (#2849)

Version [v1.16.0] - 2025-11-14

Added

  • Added option treat_markdown_warnings_as_error which throws an error when encountering a markdown/interpolation warning (#2792, #2751)
  • Footnotes can now be previewed by hovering over the link. (#2080)
  • The version selector now attempts to stay on the same page when switching between documentation versions. If the page doesn't exist in the target version, it falls back to the version homepage. (#2801)
  • Allow named @eval blocks: such a block shares its execution context with all other @eval, @example, @repl and @setup blocks on the same page which use the same name. (#2074, #2812)

Changed

  • Page category is removed from the search index and now everything is in section category. (#2762, #2413)
  • Changed the docstring block accordions from a custom implementation to HTML details+summary tag. (#2772, #2773)
  • Improved the search tokenizer and custom trimmer to improve search results. (#1457, #2114, #2744)
  • Improved several warning/error messages to (more accurately) report the location (filename, line range) in which the warning/error originated. (#2426, #2752, #2793, #2803, #2809)
  • Warn/error if jldoctest starts with an empty line; or lacks empty line between two REPL prompts. (#2031, #2083, #2679, #2808)
  • The forcepush=true option to deploydocs now uses --force-with-lease instead of --force. (#2817)
  • Improved the generation of anchors for admonitions in HTML output to be more stable and e.g. not change due to changes of the internal representation across different Julia versions. (#2710)

... (truncated)

Commits

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)

Updates the requirements on [Documenter](https://github.com/JuliaDocs/Documenter.jl) to permit the latest version.
- [Release notes](https://github.com/JuliaDocs/Documenter.jl/releases)
- [Changelog](https://github.com/JuliaDocs/Documenter.jl/blob/master/CHANGELOG.md)
- [Commits](JuliaDocs/Documenter.jl@v0.1.0...v1.17.0)

---
updated-dependencies:
- dependency-name: Documenter
  dependency-version: 1.17.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 julia Pull requests that update julia code labels May 31, 2026
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 julia Pull requests that update julia code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants