Update dependency rdoc to v8 - #71
Open
renovate[bot] wants to merge 1 commit into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR contains the following updates:
'~>6.5'→'~>8.0'Release Notes
ruby/rdoc (rdoc)
v8.0.0Compare Source
RDoc 8.0.0 is the biggest RDoc release in years. It brings together the work we have been doing to modernize Ruby's documentation experience: a Prism-based parser, RBS signatures in generated documentation,
.rbsfiles as documentation input, a live preview server, theme polish, and many long-standing bug fixes.For users, the biggest visible change is that RDoc can now show type information next to method documentation. RBS signatures are rendered in both HTML and
ri, and the Aliki theme now presents method entries as signature cards. This should make generated documentation more useful for both human readers and tools that consume Ruby documentation.For documentation authors, RDoc 8.0.0 adds
rdoc --serverandrake rdoc:server, giving you a local preview server with live reload. This release also includes many fixes around Markdown, cross-references, page links, C source handling, server mode, and generated HTML structure. The goal is to make writing and checking documentation less tedious.Internally, RDoc has migrated to the Prism-based parser and removed the old Ripper-based parser. This saves RDoc from re-implementing new Ruby syntax support manually going forward. The release also includes a refreshed coverage report, a new user-facing configuration reference, more Aliki polish, and finally, an RDoc logo.
There are breaking changes in this release, so please read the details below before upgrading. But overall, RDoc 8.0.0 is a big step toward making Ruby's documentation tooling feel actively maintained again.
What's Changed
💥 Breaking Changes
rdoc --server) by @st0012 in #1620✨ Enhancements
🐛 Bug Fixes
main_pageby @st0012 in #1624#prefix for unresolved cross-references by @st0012 in #1676📚 Documentation
RubygemsHookdoc to the right place by @st0012 in #1629🛠 Other Changes
contents: writepermission for preview of PR from ruby/rdoc by @kou in #1653ruby-titleclass by @Earlopain in #1694MetaMethodandGhostMethodby @Earlopain in #1705RDoc::Comment#{remove_private,extract_call_seq}by @Earlopain in #1706unused variablewarning in generated markdown parser by @tompng in #1708RDoc::MethodAttr#textby @Earlopain in #1710Cas the delimiter for heredocs with C code by @Earlopain in #1726New Contributors
Full Changelog: ruby/rdoc@v7.2.0...v8.0.0
v7.2.0Compare Source
What's Changed
✨ Enhancements
🐛 Bug Fixes
ArrowUporArrowDownforAlikiby @ccmywish in #1587Alikiby @ccmywish in #1593📚 Documentation
🛠 Other Changes
/release-checkClaude Code skill by @st0012 in #1604New Contributors
Full Changelog: ruby/rdoc@v7.1.0...v7.2.0
v7.1.0Compare Source
What's Changed
✨ Enhancements
🐛 Bug Fixes
~~text~~) not rendering in HTML output by @st0012 in #1541Markup::Headingas a struct on rubies older than v4.0.0 by @vinistock in #1549📚 Documentation
🛠 Other Changes
Full Changelog: ruby/rdoc@v7.0.3...v7.1.0
v7.0.4Compare Source
What's Changed
🐛 Bug Fixes
Full Changelog: ruby/rdoc@v7.0.3...v7.0.4
v7.0.3Compare Source
What's Changed
🐛 Bug Fixes
📚 Documentation
🛠 Other Changes
Full Changelog: ruby/rdoc@v7.0.2...v7.0.3
v7.0.2Compare Source
What's Changed
🐛 Bug Fixes
🛠 Other Changes
Full Changelog: ruby/rdoc@v7.0.1...v7.0.2
v7.0.1Compare Source
What's Changed
🐛 Bug Fixes
🛠 Other Changes
Full Changelog: ruby/rdoc@v7.0.0...v7.0.1
v7.0.0Compare Source
What's Changed
✨ Enhancements
🐛 Bug Fixes
📚 Documentation
CONTRIBUTING.rdocwithCONTRIBUTING.mdby @st0012 in #1496🛠 Other Changes
New Contributors
Full Changelog: ruby/rdoc@v6.17.0...v7.0.0
Configuration
📅 Schedule: (UTC)
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR was generated by Mend Renovate. View the repository job log.