Bug 351201

Summary:	ruby-ng.eclass should handle creation of API documentation itself
Product:	Gentoo Linux	Reporter:	Hans de Graaff <graaff>
Component:	Eclasses	Assignee:	Gentoo Ruby Team <ruby>
Status:	CONFIRMED ---
Severity:	normal
Priority:	High
Version:	unspecified
Hardware:	All
OS:	Linux
Whiteboard:
Package list:		Runtime testing required:	---

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.