Releases: ruby/rdoc
Releases · ruby/rdoc
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
v6.6.0
What's Changed
- ci: ensure ubuntu image has libyaml-dev for psych 5 by @flavorjones in #951
- Clean up home directories for each test by @nobu in #956
- Fix fragile tests by @nobu in #957
- Add rdoc:coverage default task by @zzak in #971
- Fix reference to proper list type RDoc::MarkupReference by @cjilbert504 in #969
- Actually execute RDoc document task for coverage by @zzak in #972
- Remove duplicate word in RDoc::MarkupReference by @cjilbert504 in #968
- Fix
RDoc::Parser::Ruby
not being documented by @etiennebarrie in #975 - Improve actions by @hsbt in #977
- Prefer to use File.readlines instead of IO.readlines by @hsbt in #980
- Use github pages action by @hsbt in #981
- Use evanphx/kpeg#58 by @hsbt in #982
- Removed badge from codeclimate by @hsbt in #989
- Use
File.binread
by @nobu in #991 - Update test libraries from ruby/ruby 2023-04-29 by @nobu in #997
- Update test libraries from ruby/ruby 2023-04-29 by @nobu in #998
- Fix ReDoS by @nobu in #999
- Fix references to nested label in table_of_contents by @nobu in #1002
- Fix generating gh-pages by @nobu in #1003
- [DOC] stop documenting fallback
MatchData#match_length
by @nobu in #1004 - Drop the support for 2.5 or earlier because of CVE-2021-31799 by @nobu in #1005
- Isolate root dir if specified by @zzak in #983
- Fix link to RDoc::Task on README by @ybiquitous in #1008
- Improve layout CSS by @ybiquitous in #1013
- Improve
<summary>
CSS on sidebar by @ybiquitous in #1012 - Configure RuboCop to remove excessive trailing new lines by @vinistock in #1018
- Embedded racc parser for portability by @hsbt in #1019
- Use flat_map for better performance by @p8 in #1022
- Fix missing closing colon for
:notnew:
by @zzak in #1023 - Add keydown event listener to focus on search field by @gemmaro in #926
- Fix to use KeyboardEvent.key over keyCode by @gemmaro in #962
- Add source_code, homepage and changelog uris to gemspec metadata by @vinistock in #1017
- Improve CSS for "toggle source" hovering over one more method signatures by @ybiquitous in #1020
- Tentatively ignore errors on TruffleRuby head by @nobu in #1028
- Removed truffleruby-head from CI by @hsbt in #1029
- Use test-unit-ruby-core instead of deep-copy from ruby repository by @hsbt in #1033
- Use a more portable way to check if code is parseable by @eregon in #1032
- handle symbols declared with %s by @theo-squadracer in #1031
- [DOC] Link fixes by @BurdetteLamar in #1035
- Omit descriptions and parameter lists for methods defined in C not mentioned in call-seq by @jeremyevans in #978
- Drop code for old versions by @nobu in #1038
- Delay DidYouMean until NotFoundError#message is called by @tompng in #1039
- test/rdoc/test_rdoc_generator_json_index.rb: Use assert_equal. by @junaruga in #1049
- test/rdoc/test_rdoc_generator_json_index.rb: pend in test_generate in ppc64le. by @junaruga in #1050
New Contributors
- @cjilbert504 made their first contribution in #969
- @etiennebarrie made their first contribution in #975
- @vinistock made their first contribution in #1018
- @p8 made their first contribution in #1022
- @theo-squadracer made their first contribution in #1031
- @tompng made their first contribution in #1039
Full Changelog: v6.5.0...v6.6.0
v6.5.0
What's Changed
- Optimize RawLine by using a regexp instead of negative look-ahead rule by @mame in #854
- Fix typo in RDoc::Task example: '.doc' -> '.rdoc' by @gemmaro in #863
- Support all struct definition functions by @nobu in #866
- Cross references to operator methods by @nobu in #865
- Skip parentheses on singleton class declaration by @soutaro in #867
- Allow cross references to logical operator methods by @nobu in #868
- Simplify attribute exclusiveness conditions by @nobu in #851
- Relative loading for easier development by @BuonOmo in #821
- Make
.rdoc_options
file plain ruby objects only by @nobu in #839 - Prefer
require 'cgi/util'
instead ofrequire 'cgi'
by @mame in #869 - Use
Marshal.load io
instead ofMarshal.load io.read
by @znz in #870 - Support crossref of methods with multiple arguments by @peterzhu2118 in #871
- Scrollable sidebar by @ybiquitous in #838
- Fold "class and module index" list by @nobu in #872
- Fix full name of known class by @nobu in #873
- Use Ruby 3.1 for CI by @aycabta in #856
- Use the custom style
details summary
only innav-section
by @nobu in #874 - Allow method source code to scroll by @nobu in #875
- Fold "Pages" list by @nobu in #876
- Use actions/checkout@v3 by @hsbt in #877
- Only parse valid URLs by @peterzhu2118 in #878
- Allow cross references to methods including underscores by @nobu in #879
- Apply matching word pairs to underscore-methods by @nobu in #880
- Fix links in docs by @peterzhu2118 in #881
- Fix a typo [ci skip] by @znz in #883
- Fix dead link in RDoc::Markup by @peterzhu2118 in #884
- Remove never used win32console by @nobu in #887
- No pager check by @nobu in #886
- Use command array form of
IO.popen
always by @nobu in #888 - Allow boolean arguments to
rb_attr
andrb_define_attr
by @nobu in #889 - Parse also InitVM-prefixed functions by @nobu in #891
- Refinement is added since ruby 3.1 by @nobu in #892
- Support attributes defined by
rb_struct_define
by @nobu in #893 - Remove dead code by @nobu in #894
- Fix an exception class name by @nobu in #895
- Fix the known classes more by @nobu in #896
- Markup reference by @BurdetteLamar in #824
- Fix call-seq for aliased method with similar names by @peterzhu2118 in #897
- Move doc/markup_reference.rb to doc/rdoc by @BurdetteLamar in #899
- [DOC] Add links to list of blocks by @BurdetteLamar in #900
- [DOC] Move section Directives into section Blocks by @BurdetteLamar in #901
- Correct error in rdoc_files by @BurdetteLamar in #902
- [DOC] Clarifications for directives by @BurdetteLamar in #903
- @github.com by @LaAzteca in #439
- [DOC] Add some links in intro; delimit rendered HTML output. by @BurdetteLamar in #904
- [DOC] Link from RDoc::Markup to RDoc::MarkupReference by @BurdetteLamar in #906
- Fix formatting blockquote in verbatim by @nobu in #908
- [DOC] Add block quotes by @BurdetteLamar in #907
- Fix blockquote with word in verbatim by @nobu in #909
- [DOC] Removes remaining old Markup Reference by @BurdetteLamar in #910
- Allow multiple footnotes without in-between blank lines by @nobu in #912
- Treat text markup (italic, bold, monofont) as blocks by @BurdetteLamar in #911
- [DOC] Make example formats explicit and consistent by @BurdetteLamar in #913
- [DOC] Improvements to Text Markup examples by @BurdetteLamar in #915
- [DOC] Mods to section Text Markup by @BurdetteLamar in #916
- [DOC] Enhances text about escapes by @BurdetteLamar in #917
- [DOC] Remove duplicated line in RDoc::MarkupReference by @peterzhu2118 in #918
- Update ruby versions in CI by @nobu in #923
- [DOC] Update the license of Darkfish by @nobu in #922
- Fix ruby script in "test_parse_method_bracket" by @yui-knk in #927
- Remove unused abbrev require by @composerinteralia in #930
- More compliant with GFM table by @nobu in #931
- Allow markup in cells by @nobu in #932
- Escape links by @nobu in #933
- Escape file names by @nobu in #934
- Change
CONTRIBUTING.rdoc
to direct readers to rdoc's GitHub Actions page by @mateusdeap in #937 - Delay
require "readline"
in case the terminal is in raw mode by @shugo in #939 - Use jruby-head by @nobu in #944
- Add epoch.rake by @nobu in #943
- Fix up Relative loading (#821) by @nobu in #945
- Refine regexp usages and reduce substring allocations by @nobu in #852
- Darkfish: Nest sidebar ToC as a tree of headings by @nevans in #941
- Darkfish: group method call-seq in div.method-header by @nevans in #942
- Refactor
RDoc::Markup::Parser#tokenize
by @nobu in #929 - Rubocop task by @nobu in #946
- Skip test option by @sriedel in #726
- Added dependabot for GitHub Actions by @hsbt in #947
- [StepSecurity] ci: Harden GitHub Actions by @step-security-bot in #948
- Non-RD parts by @nobu in #949
New Contributors
- @gemmaro made their first contribution in #863
- @soutaro made their first contribution in #867
- @peterzhu2118 made their first contribution in #871
- @ybiquitous made their first contribution in #838
- @BurdetteLamar made their first contribution in #824
- @LaAzteca made their first contribution in #439
- @yui-knk made their first contribution in #927
- @composerinteralia made their first contribution in #930
- @mateusdeap made their first contribution in #937
- @shugo made their first contribution in #939
- @nevans made their first contribution in #941
- @step-security-bot made their first contribution in #948
Full Changelog: v6.4.0...v6.5.0
v6.4.0
What's Changed
- Fix test failures by @nobu in #811
- Follow-up rubygems by @nobu in #810
- Drop support for Ruby 2.4 by @nobu in #812
- Rwrite test-case for rubygems_hook without Gem::TestCase by @hsbt in #815
- Prefer omit to pend by @nobu in #818
- Fix assertions which look very likely unintended by @nobu in #820
- Support ActiveSupport::Concern.included by @aycabta in #819
- Fix chained inclusion ancestors_of by @BuonOmo in #817
- Allow a label in a link to another document text by @nobu in #804
- Document 'ruby:' to show core documentation in ri by @xstnztk in #805
- Sync test fixes from ruby/ruby by @nobu in #823
- CI: use jruby-9.2.19.0 by @olleolleolle in #822
- Use HEAD of kpeg by @aycabta in #827
- Move RDoc::RDoc#load_options to RDoc::RDoc.load_options by @aycabta in #832
- Completely remove minitest by @hsbt in #836
- Try to load WEBrick for testing by @voxik in #833
- Add tests for
--template-stylesheets
option by @nobu in #829 - Fix smart single quote by @nobu in #831
- Convert upper case copyright and registered marks by @nobu in #837
- Update SourceCodePro font files by @aycabta in #844
- CI: use a combined workflow with a matrix by @olleolleolle in #848
- fix: use the global format default for C file comments by @flavorjones in #847
- feature: add support for
:category:
on C functions by @flavorjones in #846 - feature: Support linking #== by @flavorjones in #845
- fix: alias to a method with call-seq should render properly if the call-seq does not specify the alias by @flavorjones in #840
- Fix typos in test method names [ci skip] by @nobu in #850
- Resolve class and method of the same name correctly by @aycabta in #853
New Contributors
- @xstnztk made their first contribution in #805
- @flavorjones made their first contribution in #847
Full Changelog: v6.3.2...v6.4.0
v6.3.3
Full Changelog: v6.3.2...v6.3.3
v6.1.2.1
Full Changelog: v6.1.2...v6.1.2.1
v6.3.2
Full Changelog: v6.3.1...v6.3.2
v6.3.1
What's Changed
- Update ruby versions by @nobu in #788
- Skip non-date logs by git-log by @nobu in #789
- Support ChangeLog generated by
git log
by @nobu in #787 - Fix failing test by adding gettext as a development dependency by @dorianmariefr in #776
- Date in git log by @nobu in #790
- Fix dependency of rules to generate parser files by @nobu in #793
- Fixed CodeFence without blank lines by @nobu in #794
- Update rdoc.css sidebar panel. by @metacritical in #785
- GFM table by @nobu in #791
- Fix CI falures, JRuby on Linux and Ruby on Windows by @aycabta in #797
- Allow partial default values to be overridden with rdoc options by @aycabta in #796
- Get rid of a trailing space by @nobu in #798
- Disable other notations in
tags by @aycabta in #799
- Links to document texts without "rdoc-ref:" prefix by @nobu in #800
- CI: Use jruby-9.2.17.0 by @olleolleolle in #803
- Fix typo Genrate -> Generate by @kamipo in #806
New Contributors
Full Changelog: v6.3.0...v6.3.1