Use YARD for documentation

dickdavis · Aug 10, 2024 · f39817c · f39817c
1 parent 6f3475c
commit f39817c
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -9,3 +9,5 @@
 /spec/dummy/storage/
 /spec/dummy/tmp/
 *.gem
+.yardoc/
+docs/
diff --git a/.yardopts b/.yardopts
@@ -0,0 +1,2 @@
+--output-dir docs/
+--private
diff --git a/Gemfile b/Gemfile
@@ -14,6 +14,7 @@ group :development do
   gem 'solargraph'
   gem 'solargraph-rails'
   gem 'sqlite3'
+  gem 'yard'
 end
 
 group :test do

diff --git a/Gemfile.lock b/Gemfile.lock
@@ -126,6 +126,8 @@ GEM
     nokogiri (1.15.4)
       mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
+    nokogiri (1.15.4-x86_64-linux)
+      racc (~> 1.4)
     overcommit (0.58.0)
       childprocess (>= 0.6.3, < 5)
       iniparse (~> 1.4)
@@ -260,6 +262,7 @@ DEPENDENCIES
   solargraph-rails
   sqlite3
   warning
+  yard
 
 BUNDLED WITH
    2.2.21