diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index d7720545..9bed4e20 100644 --- a/.github/workflows/documentation.yml +++ b/.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: diff --git a/.gitignore b/.gitignore index 9ddf2573..8a0cab4d 100644 --- a/.gitignore +++ b/.gitignore @@ -17,6 +17,7 @@ bin Gemfile-custom vendor couchbase +yard_docs *.gem rubocop_cache \ No newline at end of file diff --git a/.yardopts b/.yardopts new file mode 100644 index 00000000..631a3bcd --- /dev/null +++ b/.yardopts @@ -0,0 +1 @@ +-o yard_docs \ No newline at end of file diff --git a/docs/index.txt b/docs/index.txt index 19ae9a69..47faa7ac 100644 --- a/docs/index.txt +++ b/docs/index.txt @@ -14,4 +14,5 @@ Ruby. installation-configuration schema-configuration - working-with-data \ No newline at end of file + working-with-data + API \ No newline at end of file