Changes between Initial Version and Version 1 of WikiStart/Toolchain/GeneratingDocumentation


Ignore:
Timestamp:
02/24/12 11:38:16 (8 years ago)
Author:
sylvain.joyeux
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • WikiStart/Toolchain/GeneratingDocumentation

    v1 v1  
     1== The automatic way == 
     2 
     3== The manual way == 
     4 
     5You need to install a few gems. Go in your rock installation folder and do 
     6 
     7{{{ 
     8gem install coderay webgen 
     9}}} 
     10 
     11The website pages are stored in a git repository, check it out 
     12 
     13{{{ 
     14git clone git://gitorious.org/rock/doc.git 
     15}}} 
     16 
     17Finally, generate the website 
     18 
     19{{{ 
     20cd doc 
     21rake 
     22}}} 
     23 
     24The generated output can be accessed from out/index.html 
     25 
     26To get the API documentation, run from the autoproj directory 
     27 
     28{{{ 
     29autoproj doc 
     30}}} 
     31 
     32the documentation is in install/doc 
     33 
     34Finally, the package directory information can be accessed locally with the rock-browse tool