Merge pull request #94 from Mapotempo/add_yarddoc

add yard doc

.github/workflows/documentation.yml

@@ -20,6 +20,16 @@ jobs:
         run: |
           cd docs/
           make html
+      - uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          ruby-version: 2.7
+      - name: Yard Doc build
+        run: |
+          bundle exec yard
+      - name: Merge Doc
+        run: |
+          mv yard_docs/* docs/_build/html/api
       - name: Deploy to Github Pages
         uses: peaceiris/actions-gh-pages@v4
         with:

.gitignore

@@ -17,6 +17,7 @@ bin
 Gemfile-custom
 vendor
 couchbase
+yard_docs
 
 *.gem
 rubocop_cache

.yardopts

@@ -0,0 +1 @@
+-o yard_docs

docs/index.txt

@@ -14,4 +14,5 @@ Ruby.
 
   installation-configuration
   schema-configuration
-  working-with-data
+  working-with-data
+  API <https://mapotempo.github.io/couchbase-orm/api/>