From 859e908bd606dccae468e711804acdccec17d87d Mon Sep 17 00:00:00 2001
From: Nick Charlton <nick@nickcharlton.net>
Date: Fri, 1 May 2020 17:15:17 +0100
Subject: [PATCH] Add YARD for inline documentation

* Ignores the `doc/` directory so we don't commit the generated docs,
* Includes the existing docs as files, plus the CHANGELOG, CoC, and
  LICENSE.

Fixes: #1605.
---
 .gitignore               |  2 ++
 .yardopts                | 13 +++++++++++++
 Gemfile                  |  1 +
 Gemfile.lock             |  2 ++
 gemfiles/rails42.gemfile |  1 +
 gemfiles/rails50.gemfile |  1 +
 gemfiles/rails51.gemfile |  1 +
 gemfiles/rails52.gemfile |  1 +
 gemfiles/rails60.gemfile |  1 +
 9 files changed, 23 insertions(+)
 create mode 100644 .yardopts

diff --git a/.gitignore b/.gitignore
index be82d15a2f..0ced8f286b 100644
--- a/.gitignore
+++ b/.gitignore
@@ -25,3 +25,5 @@ pkg
 /.idea
 .byebug_history
 gemfiles/.bundle/
+.yardoc
+/doc
diff --git a/.yardopts b/.yardopts
new file mode 100644
index 0000000000..77c591c8c3
--- /dev/null
+++ b/.yardopts
@@ -0,0 +1,13 @@
+-
+CHANGELOG.md
+docs/getting_started.md
+docs/rails_api.md
+docs/customizing_dashboards.md
+docs/customizing_page_views.md
+docs/customizing_attribute_partials.md
+docs/adding_controllers_without_related_model.md
+docs/adding_custom_field_types.md
+docs/authentication.md
+docs/authorization.md
+CODE_OF_CONDUCT.md
+LICENSE.md
diff --git a/Gemfile b/Gemfile
index b0a7af82b0..9c2d805766 100644
--- a/Gemfile
+++ b/Gemfile
@@ -21,6 +21,7 @@ group :development, :test do
   gem "factory_bot_rails"
   gem "i18n-tasks", "0.9.31"
   gem "pry-rails"
+  gem "yard"
 end
 
 group :test do
diff --git a/Gemfile.lock b/Gemfile.lock
index 6e9fecde64..67ffc3c78e 100644
--- a/Gemfile.lock
+++ b/Gemfile.lock
@@ -243,6 +243,7 @@ GEM
       hashdiff (>= 0.4.0, < 2.0.0)
     xpath (3.2.0)
       nokogiri (~> 1.8)
+    yard (0.9.25)
     zeitwerk (2.3.1)
 
 PLATFORMS
@@ -281,6 +282,7 @@ DEPENDENCIES
   unicorn
   webmock
   xpath (= 3.2.0)
+  yard
 
 BUNDLED WITH
    1.17.3
diff --git a/gemfiles/rails42.gemfile b/gemfiles/rails42.gemfile
index ba33da99db..ffd683c962 100644
--- a/gemfiles/rails42.gemfile
+++ b/gemfiles/rails42.gemfile
@@ -24,6 +24,7 @@ group :development, :test do
   gem "factory_bot_rails"
   gem "i18n-tasks", "0.9.31"
   gem "pry-rails"
+  gem "yard"
   gem "rspec-rails"
 end
 
diff --git a/gemfiles/rails50.gemfile b/gemfiles/rails50.gemfile
index 7b0a44eb6a..1fe3600768 100644
--- a/gemfiles/rails50.gemfile
+++ b/gemfiles/rails50.gemfile
@@ -24,6 +24,7 @@ group :development, :test do
   gem "factory_bot_rails"
   gem "i18n-tasks", "0.9.31"
   gem "pry-rails"
+  gem "yard"
   gem "rspec-rails"
 end
 
diff --git a/gemfiles/rails51.gemfile b/gemfiles/rails51.gemfile
index 664ad8d91f..f853732b6e 100644
--- a/gemfiles/rails51.gemfile
+++ b/gemfiles/rails51.gemfile
@@ -24,6 +24,7 @@ group :development, :test do
   gem "factory_bot_rails"
   gem "i18n-tasks", "0.9.31"
   gem "pry-rails"
+  gem "yard"
   gem "rspec-rails"
 end
 
diff --git a/gemfiles/rails52.gemfile b/gemfiles/rails52.gemfile
index 8d5811cc59..5449a086b6 100644
--- a/gemfiles/rails52.gemfile
+++ b/gemfiles/rails52.gemfile
@@ -24,6 +24,7 @@ group :development, :test do
   gem "factory_bot_rails"
   gem "i18n-tasks", "0.9.31"
   gem "pry-rails"
+  gem "yard"
   gem "rspec-rails"
 end
 
diff --git a/gemfiles/rails60.gemfile b/gemfiles/rails60.gemfile
index 602878ef7b..1bf0ef1f3d 100644
--- a/gemfiles/rails60.gemfile
+++ b/gemfiles/rails60.gemfile
@@ -22,6 +22,7 @@ group :development, :test do
   gem "factory_bot_rails"
   gem "i18n-tasks", "0.9.31"
   gem "pry-rails"
+  gem "yard"
   gem "rspec-rails", "~> 4.0.0.beta2"
 end