SketchUp Ruby API YARD Template

This is the customized YARD template the SketchUp team uses to generate the SketchUp Ruby API documentation.

It is made available for easy re-use. Using this gem a local copy of the documentation can be generated from our SketchUp Ruby API stubs.

Example Usage

Make sure YARD and yard-sketchup are installed:

gem install yard
gem install yard-sketchup

Example .yardopts config:

--title "SketchUp Ruby API Documentation"
--no-api
--no-private
--plugin yard-sketchup
SketchUp/**/*.rb
-
pages/*.md

The assets and pages directory can be found in the SketchUp Ruby API stubs repository.

Useful YARD Commands

TL;DR - YARD Usage

Note: The Thor commands mentioned above are wrappers on top of these YARD commands.

Generate API Documentation: yardoc

Exclude a version:

yardoc --query '@version.text != "SketchUp 2018"'

Generate API Stubs: yardoc -t stubs -f text

Generate coverage.manifest: yardoc -t coverage -f text