Ruby Reference Documentation
Use YARD to generate reference documentation for all installed Ruby gems.
First, install Yard if needed.
gem install yard
Then start a documentation server.
yard server --gems
To view/edit docs for a gem you are developing, start a server from the root directory of the gem.
cd path/to/source yard server
How'd We Do?
Was this article missing something?
Was it not quite what you were looking for?
Do you have suggestions on how we could improve this article or your experience in general?
If so, please take a moment to let us know!
Your invaluable feedback will help everyone better understand the platform!