Merge pull request #63 from Shopify/vs/use_check_docs

Publish our documentation as static website

Author: vinistock

.github/workflows/ci.yml

@@ -14,6 +14,9 @@ jobs:
           ruby-version: '3.2'
           bundler-cache: true
 
+      - name: Check if documentation is up to date
+        run: bundle exec rake ruby_lsp:check_docs
+
       - name: Typecheck
         run: bundle exec srb tc
 

.github/workflows/publish_docs.yml

@@ -0,0 +1,32 @@
+name: Publish docs
+
+on:
+  push:
+    branches: [main]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: Publish documentation website
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.2
+          bundler-cache: true
+
+      - name: Configure git
+        run: |
+          git config user.name github-actions
+          git config user.email [email protected]
+
+      - name: Generate documentation
+        run: bundle exec rake rdoc
+
+      - name: Commit to gh-pages
+        run: |
+          git add docs
+          git commit -m "Publish website $(git log --format=format:%h -1)"
+          git push --force origin main:gh-pages

Gemfile

@@ -15,6 +15,6 @@ gem "rubocop-shopify", "~> 2.13", require: false
 gem "rubocop-minitest", "~> 0.30.0", require: false
 gem "rubocop-rake", "~> 0.6.0", require: false
 gem "rubocop-sorbet", "~> 0.7", require: false
-
+gem "rdoc", require: false
 gem "sorbet-static-and-runtime"
 gem "tapioca", "~> 0.11", require: false

Gemfile.lock

@@ -126,6 +126,8 @@ GEM
     parser (3.2.2.0)
       ast (~> 2.4.1)
     prettier_print (1.2.1)
+    psych (5.1.0)
+      stringio
     puma (6.2.2)
       nio4r (~> 2.0)
     racc (1.6.2)
@@ -165,6 +167,8 @@ GEM
       parser (>= 2.6.4.0)
       sorbet-runtime (>= 0.5.9204)
       unparser
+    rdoc (6.5.0)
+      psych (>= 4.0.0)
     regexp_parser (2.8.0)
     reline (0.3.3)
       io-console (~> 0.5)
@@ -210,6 +214,7 @@ GEM
       thor (>= 0.19.2)
     sqlite3 (1.6.2-arm64-darwin)
     sqlite3 (1.6.2-x86_64-linux)
+    stringio (3.0.6)
     syntax_tree (6.1.1)
       prettier_print (>= 1.2.0)
     tapioca (0.11.5)
@@ -247,6 +252,7 @@ DEPENDENCIES
   debug (>= 1.7.0)
   mocha
   puma
+  rdoc
   rubocop (~> 1.48)
   rubocop-minitest (~> 0.30.0)
   rubocop-rake (~> 0.6.0)

Rakefile

@@ -9,11 +9,24 @@ load "rails/tasks/statistics.rake"
 
 require "bundler/gem_tasks"
 require "rake/testtask"
+require "ruby_lsp/check_docs"
+require "rdoc/task"
 
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
   t.libs << "lib"
   t.test_files = FileList["test/**/*_test.rb"]
 end
 
+RDoc::Task.new do |rdoc|
+  rdoc.main = "README.md"
+  rdoc.rdoc_files.include("*.md", "lib/**/*.rb")
+  rdoc.rdoc_dir = "docs"
+  rdoc.markup = "markdown"
+  rdoc.options.push("--copy-files", "misc")
+  rdoc.options.push("--copy-files", "LICENSE.txt")
+end
+
+RubyLsp::CheckDocs.new(FileList["#{__dir__}/lib/ruby_lsp/ruby_lsp_rails/**/*.rb"])
+
 task default: :test

lib/ruby-lsp-rails.rb

@@ -7,7 +7,7 @@
 require "ruby_lsp_rails/version"
 require "ruby_lsp_rails/railtie"
 
-module RubyLSP
+module RubyLsp
   module Rails
   end
 end

lib/ruby_lsp/ruby_lsp_rails/hover.rb

@@ -3,6 +3,17 @@
 
 module RubyLsp
   module Rails
+    # ![Hover demo](../../hover.gif)
+    #
+    # Augment [hover](https://microsoft.github.io/language-server-protocol/specification#textDocument_hover) with
+    # information about a model.
+    #
+    # # Example
+    #
+    # ```ruby
+    # User.all
+    # # ^ hovering here will show information about the User model
+    # ```
     class Hover < ::RubyLsp::Listener
       extend T::Sig
       extend T::Generic