Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 351201 - ruby-ng.eclass should handle creation of API documentation itself
Summary: ruby-ng.eclass should handle creation of API documentation itself
Status: CONFIRMED
Alias: None
Product: Gentoo Linux
Classification: Unclassified
Component: New packages (show other bugs)
Hardware: All Linux
: High normal (vote)
Assignee: Gentoo Ruby Team
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2011-01-09 12:01 UTC by Hans de Graaff
Modified: 2015-07-05 08:42 UTC (History)
0 users

See Also:
Package list:
Runtime testing required: ---


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Hans de Graaff gentoo-dev 2011-01-09 12:01:51 UTC
Currently we only have provision for this in ruby-fakegem.eclass, where we rely on the package itself to provide API documentation. This approach has a number of problems:

- not all packages provide API docs
- some packages only provide API docs functionality in the tarball, not the gem
- most packages require additional dependencies for documentation tasks (e.g. hoe, echoe, etc.)
- generated documentation is inconsistent (packages use their own templates, etc.)

A better approach would be to have supporting methods in ruby-ng.eclass that create API documentation in a consistent manner, perhaps even using a Gentoo-specific template. In the same pass we could also generate ri documentation which we currently don't do.
Comment 1 Hans de Graaff gentoo-dev 2015-07-05 08:42:19 UTC
ruby-fakegem.eclass has RUBY_FAKEGEM_RECIPE_DOC="rdoc" which handles API documentation handling outside of the package.

In a future EAPI we can change the eclass to use this recipe by default.