Releases: ruby/rdoc
Releases · ruby/rdoc
v6.12.0
What's Changed
✨ Enhancements
🐛 Bug Fixes
- Stop accepting
Document
objects asCodeObject#comment
by @tompng in #1210 - Reduce document difference between RDoc::Parser::Ruby and RDoc::Parser::PrismRuby by @tompng in #1284
🛠 Other Changes
- Bump ruby/setup-ruby from 1.207.0 to 1.213.0 by @dependabot in #1280
- Bump step-security/harden-runner from 2.10.3 to 2.10.4 by @dependabot in #1279
- Update ruby-core workflow to just generate documentation by @st0012 in #1278
- Add a
build:local_ruby
task to simplify local testing flow by @st0012 in #1281 - Bump ruby/setup-ruby from 1.213.0 to 1.214.0 by @dependabot in #1283
- Remove unnecessary
file_name
parameter fromParser#initialize
by @st0012 in #1146 - Bump ruby/setup-ruby from 1.214.0 to 1.215.0 by @dependabot in #1285
Full Changelog: v6.11.0...v6.12.0
v6.11.0
What's Changed
✨ Enhancements
- Add autolink_excluded_words option to ignore cross-references by @st0012 in #1259
- Enable
warn_missing_rdoc_ref
by default by @st0012 in #1275
🐛 Bug Fixes
- Introduce
apply_default_exclude
config to separate default and user excluding patterns by @nobu in #1251 - Fix prism_ruby superclass resolve order by @tompng in #1267
- Add missing
RDoc::RubygemsHook
API forgem server
by @mterada1228 in #1270 - Finalize RDoc::Options before calling RDoc::RDoc#parse_files by @rhenium in #1274
📚 Documentation
- Documentation for #1240 by @nobu in #1263
- [DOC] Stop autolinking the word "RDoc" by @nobu in #1266
- [DOC] Ignore racc-generated files by @nobu in #1265
- [DOC] Remove unnecessary rdoc-ref missing example by @st0012 in #1271
🛠 Other Changes
- Bump rubygems/release-gem from 1.1.0 to 1.1.1 by @dependabot in #1253
- Merge commit from ruby/ruby HEAD by @hsbt in #1255
- Exclude latest windows & Ruby 3.4 on CI by @st0012 in #1260
- Bump ruby/setup-ruby from 1.204.0 to 1.206.0 by @dependabot in #1262
- Bump ruby/setup-ruby from 1.206.0 to 1.207.0 by @dependabot in #1273
- Run ruby/ruby doc generation on CI by @st0012 in #1272
- Bump step-security/harden-runner from 2.10.2 to 2.10.3 by @dependabot in #1276
- CI: test.yml - Windows - add mswin, remove 3.4 exclude by @MSP-Greg in #1277
Full Changelog: v6.10.0...v6.11.0
v6.10.0
What's Changed
✨ Enhancements
- Print warnings for rdoc-ref links that can't be resolved by @st0012 in #1241
- Enable cross reference in code by @nobu in #1240
- Auto-hide navigation on link click by @sunblaze in #1238
🐛 Bug Fixes
🛠 Other Changes
- Fix to parse
rb_define_global_const
by @nobu in #1245 - Bump ruby/setup-ruby from 1.187.0 to 1.204.0 by @dependabot in #1246
- Update tests for #1247 by @st0012 in #1248
Full Changelog: v6.9.1...v6.10.0
v6.9.1
v6.9.0
What's Changed
✨ Enhancements
- Deprecate
main
andtitle
directives by @st0012 in #1218 - Expand rdoc-ref targets at the end of ri output by @st0012 in #1141
🐛 Bug Fixes
- Improve how gemspec's files are defined by @st0012 in #1212
- fix: C variables should never show up in Ancestors tree by @flavorjones in #1217
- Sort
MethodAttr
so that names starting with symbols are before names starting with alpha ASCII by @flavorjones in #1219 ClassModule#superclass=
accepts aClassModule
as an argument by @flavorjones in #1222- Use distinct styles for note lists and label lists by @nevans in #1209
🛠 Other Changes
- Bump step-security/harden-runner from 2.10.1 to 2.10.2 by @dependabot in #1215
- Bump rubygems/release-gem from 612653d273a73bdae1df8453e090060bb4db5f31 to 9e85cb11501bebc2ae661c1500176316d3987059 by @dependabot in #1214
- Fixed version number of rubygems/release-gem by @hsbt in #1216
- Prefer
String#ord
toString#codepoints[0]
by @flavorjones in #1220 - Workaround JRuby's jar-dependencies error and test failures on CI by @st0012 in #1225
- lint: Remove unreachable code by @okuramasafumi in #1137
- Stop running CI against JRuby and some CI config cleanup by @st0012 in #1228
- Make it loose coupling between RubyGems and RDoc by @mterada1228 in #1171
- Fixed compatibility error with setup command and rdoc plugin on rubygems by @hsbt in #1234
Full Changelog: v6.8.1...v6.9.0
v6.8.1
v6.8.0
What's Changed
✨ Enhancements
- Require space between hash/content in ATX heading by @skipkayhil in #1140
- Add new ruby parser that uses Prism by @tompng in #1144
- Add support for mobile screen sizes on Darkfish by @MatheusRich in #1025
- Modernize RDoc Darkfish template CSS by @st0012 in #1157
- Use pointer cursor for navigation toggle by @omegahm in #1175
- Add home page link to output message by @st0012 in #1165
- Improve method source toggling by @st0012 in #1176
- Make methods and attributes linkable by @st0012 in #1189
- Add support for meta tags by @vinistock in #1091
- Add scroll-margin-top on all :target elements by @omegahm in #1174
- Use scroll-margin-top on anchor targets by @st0012 in #1190
- feature: Render mixed-in methods and constants with
--embed-mixins
by @flavorjones in #842 - Red-based darkfish color scheme by @st0012 in #1191
- Use thicker fonts with high contrast to improve readability by @st0012 in #1197
- Display class ancestors in the sidebar by @alexisbernard in #1183
- Split list of class and instance methods in two by @alexisbernard in #1206
🐛 Bug Fixes
- Abort with error message if
--dump
argument invalid by @adam12 in #1104 - Fix darkfish responsiveness issue on screens between 1024px and ~1650px by @st0012 in #1148
- Fix sidebar scroll and footer display by @st0012 in #1152
- Fix sidebar scroll again and add missing footer back by @st0012 in #1154
- Make summary triangle appear in correct place when summary text overflows to next line by @paracycle in #1160
- Make darkfish more responsive and readable on mobile devices by @st0012 in #1162
- Only let browser search through source code until it's expanded by @Earlopain in #1181
- Fix ToRdoc#accept_table by @tompng in #1184
- Extract excerpt from RDoc::Markup::Document (raw pages) correctly by @st0012 in #1200
📚 Documentation
- [DOC] New file RI.md by @BurdetteLamar in #1100
- [DOC] Mods about markup formats by @BurdetteLamar in #1143
- [doc] Mention
.document
file in README by @okuramasafumi in #1153 - [DOC] Fix links by @BurdetteLamar in #1169
- Improve RDoc pages heading levels order by @antoinem in #1185
- Mention community-maintained themes by @st0012 in #1198
🛠 Other Changes
- Bump ruby/setup-ruby from 1.176.0 to 1.177.1 by @dependabot in #1112
- Bump ruby/setup-ruby from 1.177.1 to 1.179.0 by @dependabot in #1116
- Bump ruby/setup-ruby from 1.179.0 to 1.179.1 by @dependabot in #1120
- Bump ruby/setup-ruby from 1.179.1 to 1.180.0 by @dependabot in #1121
- Add ruby-core CI suite by @st0012 in #1115
- Bump ruby/setup-ruby from 1.152.0 to 1.180.1 by @dependabot in #1124
- Fix some typos by @ydah in #1129
- Bump ruby/setup-ruby from 1.180.1 to 1.183.0 by @dependabot in #1131
- Group code object files into the same directory by @st0012 in #1114
- chore(bin): Add
bin/console
for better DX by @okuramasafumi in #1132 - Drop reimplementation of Ripper lex state by @nevans in #1118
- Bump ruby/setup-ruby from 1.183.0 to 1.185.0 by @dependabot in #1136
- RDoc task should include top-level .md files too by @st0012 in #1134
- Bump ruby/setup-ruby from 1.185.0 to 1.187.0 by @dependabot in #1142
- Improve rubocop setup by @st0012 in #1139
- Drop unnecessary
file_name
parameter fromParser.for
method. by @st0012 in #1135 - Follow up changes for Prism Ruby parser by @st0012 in #1145
- Fix flaky test: prevent regexp match to tempdir path by @tompng in #1147
- Use ascii chatacter in HTML file to fix ruby ci failure by @tompng in #1150
- Avoid potentially loading the same extension from different versions of the same gem by @deivid-rodriguez in #1155
- Align behaviour between
bundle exec rdoc
andrake rdoc
by @st0012 in #1156 - Tunes up .document by @BurdetteLamar in #1161
rake install
command is failed by @mterada1228 in #1170- Add more space after magnifying glass by @omegahm in #1173
- Fix ruby-core test suite by @st0012 in #1187
- Use normal
font-weight
for links by @sambostock in #1188 - Add release.yml by @st0012 in #1193
- Hack for Safari 18 by @nobu in #1195
New Contributors
- @st0012 made their first contribution in #1115
- @ydah made their first contribution in #1129
- @MatheusRich made their first contribution in #1025
- @paracycle made their first contribution in #1160
- @mterada1228 made their first contribution in #1170
- @omegahm made their first contribution in #1173
- @Earlopain made their first contribution in #1181
- @sambostock made their first contribution in #1188
- @antoinem made their first contribution in #1185
- @alexisbernard made their first contribution in #1183
Full Changelog: v6.7.0...v6.8.0
v6.7.0
What's Changed
- Fix support for
rb_file_const
andrb_curses_define_const
by @nobu in #1069 - Bump actions/upload-pages-artifact from 2 to 3 by @dependabot in #1071
- Bump actions/deploy-pages from 3 to 4 by @dependabot in #1070
- Use master of setup-ruby by @nobu in #1072
- Allow empty name rdoc-ref as a local link by @nobu in #1073
- [DOC] MarkupReference by @BurdetteLamar in #1075
- Bump ruby/setup-ruby from 1.162.0 to 1.165.1 by @dependabot in #1074
- [DOC] Tweaks to Markup Reference by @BurdetteLamar in #1077
- Sort coverage outputs by @nobu in #1078
- Ignore
locale
atwrite_options
by @nobu in #1079 - Singleton visibility by @nobu in #1080
- Respect modeline to detect parser by @nobu in #1081
- Bump ruby/setup-ruby from 1.165.1 to 1.169.0 by @dependabot in #1085
- Don't document aliases with trailing
:nodoc
directive by @p8 in #1090 - Bump ruby/setup-ruby from 1.169.0 to 1.171.0 by @dependabot in #1089
- Bump ruby/setup-ruby from 1.171.0 to 1.172.0 by @dependabot in #1092
- Fix ToMarkdown missing newlines for label-lists by @skipkayhil in #1094
- Fix ToRdoc generating incorrect {label,name}-lists by @skipkayhil in #1093
- [DOC] Improve documentation of
:include:
directive file search by @p8 in #1083 - Allow rich definition list labels for Markdown by @skipkayhil in #1096
- Test only with truffleruby-head by @nobu in #1095
- test: Add tests for
RDoc::TokenStream
class by @toshimaru in #1068 - Use readline history when
ri
is running interactive by @adam12 in #861 - Revert "Test only with truffleruby-head" by @eregon in #1099
- Bump ruby/setup-ruby from 1.172.0 to 1.173.0 by @dependabot in #1101
- Bump actions/configure-pages from 4 to 5 by @dependabot in #1102
- Bump ruby/setup-ruby from 1.173.0 to 1.174.0 by @dependabot in #1105
- Bump ruby/setup-ruby from 1.174.0 to 1.175.1 by @dependabot in #1106
- Bump ruby/setup-ruby from 1.175.1 to 1.176.0 by @dependabot in #1108
- Fix typo in CONTRIBUTING.md by @okuramasafumi in #1109
- [DOC] Correct
.rdoc_options
filename in comment by @adam12 in #1103
New Contributors
- @skipkayhil made their first contribution in #1094
- @adam12 made their first contribution in #861
- @okuramasafumi made their first contribution in #1109
Full Changelog: v6.6.3.1...v6.7.0
v6.6.2
What's Changed
- Allow any single-word token upto 2 before C method implementation by @nobu in #1061
- Fix C const comment by @nobu in #1062
- Bump actions/deploy-pages from 2 to 3 by @dependabot in #1063
- Bump actions/configure-pages from 3 to 4 by @dependabot in #1064
- Bump ruby/setup-ruby from 1.161.0 to 1.162.0 by @dependabot in #1065
- Add missing documents by @nobu in #1066
Full Changelog: v6.6.1...v6.6.2
v6.6.1
What's Changed
- Bump ruby/setup-ruby from 1.159.0 to 1.161.0 by @dependabot in #1052
- Fix TIDYLINK after braces (#1015) by @nobu in #1054
- Fix
NoMethodError
fortokens_to_s
method by @toshimaru in #1055 - Place a space between certain character class letters only by @nobu in #1057
- Re-enable tests with truffleruby-head by @nobu in #1058
- Get rid of
Kernel#open
by @nobu in #1059 - Markup punctuations need to be separated with a space by @nobu in #1060
- fix: Return empty string when
token_stream
isnil
by @toshimaru in #1056
Full Changelog: v6.6.0...v6.6.1