diff options
| author | a14m <[email protected]> | 2020-12-03 15:25:02 +0100 |
|---|---|---|
| committer | a14m <[email protected]> | 2020-12-03 15:25:02 +0100 |
| commit | e9e61b667af268b1f1da40f2ed2cd5bf30016456 (patch) | |
| tree | 6b2aeb4135761b92b4795f8ee73532ddd72d65bd | |
| parent | 1404a38b5b6fbfe971729d24bd46e10b8d2da9fc (diff) | |
Add yard for documentation
| -rw-r--r-- | CLI/ruby/.yardopts | 8 | ||||
| -rw-r--r-- | CLI/ruby/Gemfile.lock | 4 | ||||
| -rw-r--r-- | CLI/ruby/game_of_life.gemspec | 3 |
3 files changed, 15 insertions, 0 deletions
diff --git a/CLI/ruby/.yardopts b/CLI/ruby/.yardopts new file mode 100644 index 0000000..319084e --- /dev/null +++ b/CLI/ruby/.yardopts @@ -0,0 +1,8 @@ +lib/**/*.rb + +--readme README.md +--markup markdown +--markup-provider redcarpet +--protected +--private +--tag smell:"Code smells" diff --git a/CLI/ruby/Gemfile.lock b/CLI/ruby/Gemfile.lock index c7f2669..447b89a 100644 --- a/CLI/ruby/Gemfile.lock +++ b/CLI/ruby/Gemfile.lock @@ -23,6 +23,7 @@ GEM pry (~> 0.13.0) rainbow (3.0.0) rake (13.0.1) + redcarpet (3.5.0) regexp_parser (2.0.0) rexml (3.2.4) rspec (3.10.0) @@ -52,6 +53,7 @@ GEM ruby-progressbar (1.10.1) thor (1.0.1) unicode-display_width (1.7.0) + yard (0.9.25) PLATFORMS ruby @@ -61,8 +63,10 @@ DEPENDENCIES game_of_life! pry-byebug rake + redcarpet rspec rubocop + yard BUNDLED WITH 2.1.4 diff --git a/CLI/ruby/game_of_life.gemspec b/CLI/ruby/game_of_life.gemspec index 3131ad3..13eaeb5 100644 --- a/CLI/ruby/game_of_life.gemspec +++ b/CLI/ruby/game_of_life.gemspec @@ -29,4 +29,7 @@ Gem::Specification.new do |spec| spec.add_development_dependency "rake" spec.add_development_dependency "rspec" spec.add_development_dependency "rubocop" + # Documentation dependencies + spec.add_development_dependency "yard" + spec.add_development_dependency "redcarpet" end |