add yard doc to documentation

Author: senid231

.gitignore

@@ -16,4 +16,5 @@ Gemfile.lock
 
 # docs
 /docs/.vuepress/dist/
+/docs/.vuepress/public/api/
 /node_modules/

.rubocop.yml

@@ -4,6 +4,7 @@ AllCops:
   Exclude:
     - vendor/**/*
     - tmp/**/*
+    - docs/**/*
 
 # Capybara/RSpec uses have_ had_ as name convention for matchers.
 Naming/PredicateName:

.travis.yml

@@ -29,9 +29,10 @@ jobs:
       script: bundle exec rake default
     - name: "Deploy documentation"
       stage: deploy
-      install: skip
       before_script: yarn install
-      script: yarn docs:build
+      script:
+        - bundle exec rake yard
+        - yarn docs:build
       deploy:
         provider: pages
         edge: true

Gemfile

@@ -14,6 +14,7 @@ gem 'rake', '~> 12.0'
 gem 'rspec-rails', '~> 4.0'
 gem 'rubocop', '~> 0.81.0', require: false
 gem 'system_test_html_screenshots', require: false
+gem 'yard', require: false
 
 gem 'activeadmin', ENV.fetch('ACTIVE_ADMIN_VERSION', '~> 2.0'), require: false
 gem 'rails', ENV.fetch('RAILS_VERSION', '6.0.0')

Rakefile

@@ -3,8 +3,16 @@
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'rubocop/rake_task'
+require 'yard'
+require 'yard/rake/yardoc_task'
 
 RSpec::Core::RakeTask.new(:spec)
 RuboCop::RakeTask.new(:rubocop)
+YARD::Rake::YardocTask.new(:yard) do |task|
+  task.options += [
+      %(--output-dir=./docs/.vuepress/public/api/),
+      %(--title=Capybara Active Admin API Reference)
+  ]
+end
 
 task default: [:rubocop, :spec]

deploy.sh

@@ -5,6 +5,7 @@ module.exports = {
   themeConfig: {
     nav: [
       { text: 'Guide', link: '/guide/' },
+      { text: 'API Reference', link: '/api/', target: '_blank' },
       { text: 'GitHub', link: 'https://github.com/activeadmin-plugins/capybara_active_admin' }
     ]
   }