Merge pull request #106 from LTe/docs

Generate yard documentation as github page

.travis.yml

@@ -1,3 +1,7 @@
+stages:
+  - "Static analysis"
+  - "Test"
+  - "Documentation"
 matrix:
   allow_failures:
     - rvm: ruby-head
@@ -24,7 +28,19 @@ matrix:
       gemfile: gemfiles/rails_6.0.gemfile
       name: "Rubocop"
       script: rake rubocop
+    - rvm: 2.7
+      stage: "Documentation"
+      name: "Documentation"
+      before_deploy: 'bundle exec yard doc --private'
+      deploy:
+        provider: pages
+        skip_cleanup: true
+        github_token: $GITHUB_TOKEN
+        local_dir: doc
+        on:
+          branch: master
 before_install:
   - gem update --system
   - gem install bundler
-install: bundle install --jobs=3 --retry=3
+cache: bundler
+

Gemfile

@@ -15,4 +15,5 @@ group :development do
   gem 'rubocop', require: false
   gem 'sqlite3'
   gem 'timecop'
+  gem 'yard'
 end

Gemfile.lock

@@ -157,6 +157,7 @@ GEM
     tzinfo (1.2.7)
       thread_safe (~> 0.1)
     unicode-display_width (1.7.0)
+    yard (0.9.25)
     zeitwerk (2.3.0)
 
 PLATFORMS
@@ -174,6 +175,7 @@ DEPENDENCIES
   rubocop
   sqlite3
   timecop
+  yard
 
 BUNDLED WITH
    2.1.4

gemfiles/rails_3.2.gemfile

@@ -17,4 +17,5 @@ group :development do
   gem 'rubocop', require: false
   gem 'sqlite3', '~> 1.3.6'
   gem 'timecop'
+  gem 'yard'
 end

gemfiles/rails_4.2.gemfile

@@ -18,4 +18,5 @@ group :development do
   gem 'rubocop', require: false
   gem 'sqlite3', '~> 1.3.6'
   gem 'timecop'
+  gem 'yard'
 end

gemfiles/rails_5.2.gemfile

@@ -17,4 +17,5 @@ group :development do
   gem 'rubocop', require: false
   gem 'sqlite3', '~> 1.3.6'
   gem 'timecop'
+  gem 'yard'
 end

gemfiles/rails_6.0.gemfile

@@ -17,4 +17,5 @@ group :development do
   gem 'rubocop', require: false
   gem 'sqlite3', '~> 1.4.0'
   gem 'timecop'
+  gem 'yard'
 end

gemfiles/rails_master.gemfile

@@ -17,4 +17,5 @@ group :development do
   gem 'rubocop', require: false
   gem 'sqlite3'
   gem 'timecop'
+  gem 'yard'
 end