From f39817c65f7bfa81c75800dc4231e47eee73849a Mon Sep 17 00:00:00 2001
From: Dick Davis <dick@hey.com>
Date: Fri, 9 Aug 2024 20:41:49 -0500
Subject: [PATCH] Use YARD for documentation

---
 .gitignore   | 2 ++
 .yardopts    | 2 ++
 Gemfile      | 1 +
 Gemfile.lock | 3 +++
 4 files changed, 8 insertions(+)
 create mode 100644 .yardopts

diff --git a/.gitignore b/.gitignore
index 68bfdd1..10d449b 100644
--- a/.gitignore
+++ b/.gitignore
@@ -9,3 +9,5 @@
 /spec/dummy/storage/
 /spec/dummy/tmp/
 *.gem
+.yardoc/
+docs/
diff --git a/.yardopts b/.yardopts
new file mode 100644
index 0000000..c735946
--- /dev/null
+++ b/.yardopts
@@ -0,0 +1,2 @@
+--output-dir docs/
+--private
diff --git a/Gemfile b/Gemfile
index 508a5cf..8d9a0cb 100644
--- 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
index 9c8a586..75ee828 100644
--- 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