tinydoc-plugin-yard-api
v5.0.0
Published
A YARD-API/Rails documentation generator plugin for tinydoc.
Downloads
17
Maintainers
Readme
YARD-API tinydoc Plugin
This plugin parses Rails controllers that are documented in the YARD-API format.
Configuration
// tinydoc.conf.js
exports['yard-api'] = {
/**
* @property {String}
*
* The full command to use for generating the JSON YARD-API documents.
* This will be run in the repository's root (dir of tinydoc.conf.js).
*/
command: "bundle exec rake yard_api",
/**
* @property {String}
*
* Pattern to find the generated JSON documents.
*/
source: "public/doc/api/**/*.json",
/**
* @property {RegExp}
*
* Pattern to exclude any matched JSON source files.
*/
exclude: null,
/**
* @property {Boolean}
*
* TODO: this is currenty dysfunctional.
*/
showEndpointPath: false
};