wiki:WikiStart/Toolchain/GeneratingDocumentation

Version 1 (modified by sylvain.joyeux, 9 years ago) (diff)

--

The automatic way

The manual way

You need to install a few gems. Go in your rock installation folder and do

gem install coderay webgen

The website pages are stored in a git repository, check it out

git clone git://gitorious.org/rock/doc.git

Finally, generate the website

cd doc
rake

The generated output can be accessed from out/index.html

To get the API documentation, run from the autoproj directory

autoproj doc

the documentation is in install/doc

Finally, the package directory information can be accessed locally with the rock-browse tool