Taskfile.yml in convenient_service-0.14.0 vs Taskfile.yml in convenient_service-0.15.0
- old
+ new
@@ -337,11 +337,17 @@
#
# NOTE: options are specified in the `.yardopts` file.
#
docs:generate:
cmds:
- - bundle exec yardoc
+ ##
+ # NOTE: yard supports plugins as gems only.
+ # - https://rubydoc.info/gems/yard/file/docs/GettingStarted.md#plugin-support
+ #
+ # NOTE: `RUBYLIB` is used to extend Ruby's `$LOAD_PATH`. This way yard treats `./yard` folder as a directory with custom gems.
+ #
+ - RUBYLIB=./yard bundle exec yardoc
docs:generate:open:
cmds:
- task: docs:generate
- task: docs:open
@@ -662,6 +668,12 @@
- tmuxinator start convenient_service --project-config=.dev/.tmuxinator.yml
yard_junk:
cmds:
- mkdir -p docs
- - bundle exec yard-junk --text --html docs/junk-yard.html
+ ##
+ # NOTE: yard supports plugins as gems only.
+ # - https://rubydoc.info/gems/yard/file/docs/GettingStarted.md#plugin-support
+ #
+ # NOTE: `RUBYLIB` is used to extend Ruby's `$LOAD_PATH`. This way yard treats `./yard` folder as a directory with custom gems.
+ #
+ - RUBYLIB=./yard bundle exec yard-junk --text --html docs/junk-yard.html