ruby/.rdoc_options

---
page_dir: doc
charset: UTF-8
encoding: UTF-8
main_page: index.md
title: Documentation for Ruby development version
visibility: :private
rdoc_include:
- doc

exclude:
- \Alib/irb
- \.gemspec\z

autolink_excluded_words:
- Class
- Method
- Module
- Process
- RDoc
- Ruby
- Set

canonical_root: https://docs.ruby-lang.org/en/master
[DOC] Add `.rdoc_options` file Set `--page-dir` option so that direct rdoc call is consistent with `make html`. 2022-02-11 11:25:05 +09:00			`---`
			`page_dir: doc`
[DOC] Load options and parse files from srcdir RDoc options that do not change and can be written in `.rdoc_options` file are moved, so that they match when called without `make`. Get rid of parsing the files in `page_dir` twice (as relative paths and absolute paths). 2024-01-06 20:04:14 +09:00			`charset: UTF-8`
			`encoding: UTF-8`
[DOC] New homepage for docs.ruby-lang.org/en (#12227) 2024-12-07 02:51:08 +08:00			`main_page: index.md`
[DOC] Set the documentation title and main page Copied from https://github.com/ruby/docs.ruby-lang.org/ to be as same as docs.ruby-lang.org. 2022-02-21 13:05:24 +09:00			`title: Documentation for Ruby development version`
[DOC] Load options and parse files from srcdir RDoc options that do not change and can be written in `.rdoc_options` file are moved, so that they match when called without `make`. Get rid of parsing the files in `page_dir` twice (as relative paths and absolute paths). 2024-01-06 20:04:14 +09:00			`visibility: :private`
Sync strscan HEAD again. https://github.com/ruby/strscan/pull/99 split document with multi-byte chars. 2024-06-04 12:40:08 +09:00			`rdoc_include:`
			`- doc`
Exclude irb from documentation generation - IRB has its own documentation in the project readme and https://ruby.github.io/irb/ already. - As a tool, its internal implementation details are not relevant to the user. - Excluding it from the documentation generation reduces the size of the generated documentation and makes search results more relevant. I also checked the there are no references to IRB so it should not break any links. 2024-12-12 23:39:24 +00:00
			`exclude:`
[DOC] Fix `exclude:` as regexps 2025-01-07 13:29:35 +09:00			`- \Alib/irb`
[DOC] Escape dot in regexp 2025-05-19 22:41:56 +09:00			`- \.gemspec\z`
Exclude 'Ruby' and 'Set' from RDoc's autolinking 2024-12-31 12:23:38 +00:00
			`autolink_excluded_words:`
[DOC] Exclude 'Class' and 'Module' from RDoc's autolinking 2025-01-02 12:36:06 +09:00			`- Class`
[DOC] Exclude 'Method' from RDoc's autolinking 2025-01-02 12:06:06 +09:00			`- Method`
[DOC] Exclude 'Class' and 'Module' from RDoc's autolinking 2025-01-02 12:36:06 +09:00			`- Module`
[DOC] Exclude 'Process' from RDoc's autolinking 2025-01-02 11:58:15 +09:00			`- Process`
[ruby/rdoc] Stop autolinking the word "RDoc" (https://github.com/ruby/rdoc/pull/1266) https://github.com/ruby/rdoc/commit/73af94e3e3 2025-01-02 02:06:08 +09:00			`- RDoc`
Exclude 'Ruby' and 'Set' from RDoc's autolinking 2024-12-31 12:23:38 +00:00			`- Ruby`
			`- Set`
[DOC] Set canonical root for online docs (#13410) 2025-05-22 17:18:46 +01:00
			`canonical_root: https://docs.ruby-lang.org/en/master`