Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bump typedoc from 0.23.28 to 0.24.8 #93

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

dependabot[bot]
Copy link

@dependabot dependabot bot commented on behalf of github Jul 1, 2023

Bumps typedoc from 0.23.28 to 0.24.8.

Release notes

Sourced from typedoc's releases.

v0.24.8

Features

  • Added support for TypeScript 5.1, #2296.
  • Added navigation.fullTree to control rendering the full navigation tree on each page, #2287. This option will likely be replaced in 0.25 with dynamic loading of the full tree.
  • TypeDoc's --pretty option now also controls whether generated HTML contains line breaks, #2287.
  • Optimized icon caching to reduce file size in generated HTML documentation, #2287.
  • Render property description of "roughly top level" object types, #2276.
  • Added MarkdownEvent.INCLUDE for plugins, #2284.

Bug Fixes

  • When rendering functions/methods, TypeDoc will now render the comment summary above the parameters/return type, and any other block tags in the order they are defined in the comment, #2285.
  • Comments are no longer removed from classes/interfaces containing call signatures, #2290.

Thanks!

v0.24.7

Features

  • TypeDoc will now allow conversion without any entry points to support "readme only" packages, #2264.

Bug Fixes

  • Category children are now sorted according to the sort option, #2272.
  • Inline tags no longer require a space after the tag name to be parsed as a tag, #2273.
  • Fixed module/namespace links in navigation when viewed in Safari, #2275.

v0.24.6

Features

  • Improved error messaging if a provided entry point could not be converted into a documented module reflection, #2242.
  • API: Added support for g, circle, ellipse, polygon, and polyline svg elements, #2259.
  • Extended jsDocCompatibility option with inheritDocTag to ignore fully lowercase inheritDoc tags and ignoreUnescapedBraces to disable warnings about unescaped { and } characters in comments.

Bug Fixes

  • --useTsLinkResolution is no longer ignored within block tags, #2260.
  • The current namespace will also be expanded in the navigation on page load, #2260.
  • Fixed flicker of navigation pane when reloading a page caused by updating expansion state after the page was loaded.
  • Fixed an infinite loop if more than one entry point was provided, and all entry points were the same.

... (truncated)

Changelog

Sourced from typedoc's changelog.

v0.24.8 (2023-06-04)

Features

  • Added support for TypeScript 5.1, #2296.
  • Added navigation.fullTree to control rendering the full navigation tree on each page, #2287. This option will likely be replaced in 0.25 with dynamic loading of the full tree.
  • TypeDoc's --pretty option now also controls whether generated HTML contains line breaks, #2287.
  • Optimized icon caching to reduce file size in generated HTML documentation, #2287.
  • Render property description of "roughly top level" object types, #2276.
  • Added MarkdownEvent.INCLUDE for plugins, #2284.

Bug Fixes

  • When rendering functions/methods, TypeDoc will now render the comment summary above the parameters/return type, and any other block tags in the order they are defined in the comment, #2285.
  • Comments are no longer removed from classes/interfaces containing call signatures, #2290.

Thanks!

v0.24.7 (2023-05-08)

Features

  • TypeDoc will now allow conversion without any entry points to support "readme only" packages, #2264.

Bug Fixes

  • Category children are now sorted according to the sort option, #2272.
  • Inline tags no longer require a space after the tag name to be parsed as a tag, #2273.
  • Fixed module/namespace links in navigation when viewed in Safari, #2275.

v0.24.6 (2023-04-24)

Features

  • Improved error messaging if a provided entry point could not be converted into a documented module reflection, #2242.
  • API: Added support for g, circle, ellipse, polygon, and polyline svg elements, #2259.
  • Extended jsDocCompatibility option with inheritDocTag to ignore fully lowercase inheritDoc tags and ignoreUnescapedBraces to disable warnings about unescaped { and } characters in comments.

Bug Fixes

  • --useTsLinkResolution is no longer ignored within block tags, #2260.
  • The current namespace will also be expanded in the navigation on page load, #2260.
  • Fixed flicker of navigation pane when reloading a page caused by updating expansion state after the page was loaded.
  • Fixed an infinite loop if more than one entry point was provided, and all entry points were the same.

... (truncated)

Commits
  • c1c87c6 Update changelog for release
  • 0b2a8ea Bump version to 0.24.8
  • 60c4d53 Add navigation.fullTree option
  • 82016b8 Update changelog
  • 4ad6a31 Add test for unrelated getter/setter types
  • d05a49b Added support for TypeScript 5.1 (#2300)
  • 6d92e84 Render objects one level deep
  • c9dee38 Update comment rendering for functions
  • 2624c28 Fix call signature handling on classes/interfaces
  • 5b9ead6 Update changelog
  • Additional commits viewable in compare view

Dependabot compatibility score

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

Bumps [typedoc](https://github.com/TypeStrong/TypeDoc) from 0.23.28 to 0.24.8.
- [Release notes](https://github.com/TypeStrong/TypeDoc/releases)
- [Changelog](https://github.com/TypeStrong/typedoc/blob/master/CHANGELOG.md)
- [Commits](TypeStrong/typedoc@v0.23.28...v0.24.8)

---
updated-dependencies:
- dependency-name: typedoc
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot dependabot bot added dependencies Pull requests that update a dependency file javascript Pull requests that update Javascript code labels Jul 1, 2023
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 javascript Pull requests that update Javascript code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

0 participants