Categories: None [Edit]
inventory-rake-tasks-yard
Inventory-Rake-Tasks-YARD
Inventory-Rake-Tasks-YARD provides Rake┬╣ tasks for YARD┬▓ using your
Inventory┬│.
┬╣ See http://rake.rubyforge.org/
┬▓ See http://yardoc.org/
┬│ See http://disu.se/software/inventory/
§ Installation
Install Inventory-Rake-Tasks-YARD with
% gem install inventory-rake-tasks-yard
§ Usage
Include the following code in your ‹Rakefile› (assuming that you’ve already
set up Inventory-Rake┬╣:
Inventory::Rake::Tasks.unless_installing_dependencies do
require 'inventory-rake-tasks-yard-1.0'
Inventory::Rake::Tasks::YARD.new
end
ThisΓÇÖll define the following tasks:
= .yardopts (file). = Create .yardopts file; depends on the file defining
this task and Rakefile.
= html. = Generate documentation in HTML format for all lib files in the
inventory; depends on .yardopts file.
‹Inventory::Rake::Tasks::YARD› takes a couple of options, but the ones you
might want to adjust are
= :options. = The options to pass to YARD; will be passed to
`Shellwords.shelljoin`.
= :globals. = The globals to pass to YARD.
= :files. = The files to process; mainly used if you want to add additional
files to process beyond the lib files in the inventory.
The options passed to YARD will be augmented with any options you list in a
file named ‹.yardopts.task›, where ‹task› is the name of the Rake task
invoking YARD, for example, ‹.yardopts.html› for the default
HTML-generating task. You can use this to add options that are local to
your installation and should thus not be listed in the Rakefile itself.
See the {API documentation}┬▓ for more information.
┬╣ See http://disu.se/software/inventory-rake/
┬▓ See http://disu.se/software/inventory-rake-tasks-yard/api/Inventory/Rake/Tasks/YARD/
§ Financing
Currently, most of my time is spent at my day job and in my rather busy
private life. Please motivate me to spend time on this piece of software
...
Total
Ranking: 34,988 of 183,477
Downloads: 32,467
Daily
Ranking: 41,916 of 183,470
Downloads: 1
Downloads Trends
Ranking Trends
Num of Versions Trends
Popular Versions (Major)
Popular Versions (Major.Minor)
Depended by
Rank | Downloads | Name |
---|---|---|
22,686 | 59,037 | inventory |
33,530 | 34,417 | lookout |
34,658 | 32,880 | inventory-rake |
40,741 | 26,631 | value |
61,849 | 15,204 | lookout-rake |
67,649 | 13,372 | ame |
77,575 | 10,922 | u |
99,729 | 7,319 | lookout-rack |
Depends on
Rank | Downloads | Name |
---|---|---|
10 | 969,073,546 | rake |
224 | 160,939,746 | yard |
22,686 | 59,037 | inventory |
33,530 | 34,417 | lookout |
34,658 | 32,880 | inventory-rake |
51,619 | 19,375 | yard-heuristics |
61,849 | 15,204 | lookout-rake |
Owners
# | Gravatar | Handle |
---|---|---|
1 | now |