---
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements.  See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with
# the License.  You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

title: Building the Webgen Docs
--- 

Overview
=============================

We are using [webgen](http://webgen.rubyforge.org/) for generating nice HTML based documentation.

Installing 
-----------------------------

You first need ruby and rubygems installed on your system. 
You should have gems version of 1.3.4 or greater. You can check this via 

gem --version

To update gems do 
gem update --system 

Then you can install webgen with the following command.

`sudo gem install webgen coderay feedtools haml RedCloth`

Building 
-----------------------------

It's as simple as running `webgen` in the current directory.  Output is stored in 
the `out` directory.