en-US/building-documentation.xml

<?xml version='1.0' encoding='utf-8' ?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
%BOOK_ENTITIES;
]>

<!-- 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.
-->

<section id="building-documentation">
    <title>Building &PRODUCT; Documentation</title>
    <para>To build a specific guide, go to the source tree of the documentation in /docs and identify the guide you want to build.</para>
    <para>Currently there are four guides plus the release notes, all defined in publican configuration files:</para>
    <programlisting>
        publican-adminguide.cfg
        publican-devguide.cfg
        publican-installation.cfg
        publican-plugin-niciranvp.cfg
        publican-release-notes.cfg
    </programlisting>
    <para>To build the Developer guide for example, do the following:</para>
    <programlisting>publican build --config=publican-devguide.cfg --formats=pdf --langs=en-US</programlisting>
    <para>A pdf file will be created in tmp/en-US/pdf, you may choose to build the guide in a different format like html. In that case just replace the format value.</para>
    
</section>