Adding yard

Author: andreibondarev

.github/workflows/ci.yml

@@ -25,8 +25,20 @@ jobs:
           bundler-cache: true
 
       - name: StandardRb check
-        run: bundle exec standardrb
+        run: bundle exec standardrb --format progress --format github --color
 
       - name: Run tests
         run: |
-          bundle exec rspec 
+          bundle exec rspec
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@master
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.2
+          bundler: default
+          bundler-cache: true
+      - name: Build docs
+        run: bundle exec rake yard

Gemfile.lock

@@ -50,6 +50,7 @@ GEM
       pry (>= 0.13, < 0.15)
     rainbow (3.1.1)
     rake (13.0.6)
+    rdiscount (2.2.7.1)
     regexp_parser (2.7.0)
     rexml (3.2.5)
     rspec (3.11.0)
@@ -89,6 +90,7 @@ GEM
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.4.2)
+    yard (0.9.34)
 
 PLATFORMS
   x86_64-darwin-19
@@ -97,9 +99,11 @@ PLATFORMS
 DEPENDENCIES
   pry-byebug (~> 3.9)
   rake (~> 13.0)
+  rdiscount
   rspec (~> 3.0)
   standard (~> 1.25.0)
   weaviate-ruby!
+  yard
 
 BUNDLED WITH
    2.4.0

Rakefile

@@ -2,7 +2,12 @@
 
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require "yard"
 
 RSpec::Core::RakeTask.new(:spec)
 
 task default: :spec
+
+YARD::Rake::YardocTask.new do |t|
+  t.options = ["--fail-on-warning"]
+end

weaviate.gemspec

@@ -39,4 +39,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency "faraday_middleware", "~> 1"
   spec.add_dependency "graphlient", "~> 0.6.0"
   spec.add_development_dependency "pry-byebug", "~> 3.9"
+  spec.add_development_dependency "yard"
+  spec.add_development_dependency "rdiscount" # for github-flavored markdown in yard
 end