Skip to content

Commit

Permalink
Use markdown format for docs (#890)
Browse files Browse the repository at this point in the history
* Convert irb.rb's document into markdown format

* Hide should-be-private top-level methods from docs

* Skip xmp.rb's docs

* Declare lib/irb.rb's markup do it works in ruby/ruby too

* Ignore docs folder
  • Loading branch information
st0012 committed Mar 16, 2024
1 parent 35b87cf commit e9a175e
Show file tree
Hide file tree
Showing 5 changed files with 619 additions and 589 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,5 @@
/pkg/
/spec/reports/
/tmp/
/docs/
Gemfile.lock
9 changes: 9 additions & 0 deletions Rakefile
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
require "bundler/gem_tasks"
require "rake/testtask"
require "rdoc/task"

Rake::TestTask.new(:test) do |t|
t.libs << "test" << "test/lib"
Expand Down Expand Up @@ -42,3 +43,11 @@ Rake::TestTask.new(:test_yamatanooroti) do |t|
end

task :default => :test

RDoc::Task.new do |rdoc|
rdoc.title = "IRB"
rdoc.rdoc_files.include("*.md", "lib/**/*.rb")
rdoc.rdoc_files.exclude("lib/irb/xmp.rb")
rdoc.rdoc_dir = "docs"
rdoc.options.push("--copy-files", "LICENSE.txt")
end

0 comments on commit e9a175e

Please sign in to comment.