✅ check the document generation on push (#38)

Author: ianardee

.github/workflows/linting.yml

@@ -24,3 +24,7 @@ jobs:
     - name: Analyse the code with Rubocop
       run: |
         bundle exec rubocop ./
+
+    - name: Attempt to generate the documentation
+      run: |
+        bundle exec rake doc

.yardopts

@@ -1,3 +1,4 @@
 --markup markdown
 --main README.md
+--fail-on-warning
 --output-dir docs/_build