wiki:Docs/Build

Version 4 (modified by Amar Takhar, on 01/19/16 at 02:46:03) (diff)

Remove comment note about 'book' document as it is not ready.

Build Documentation

Table of Contents

  1. Build Documentation
    1. Prerequisites
    2. Sphinx
    3. Getting Source
    4. Building

This page explains how to build the documentation from source.

Prerequisites

You will need:

  • ​waf - The waf build system.
  • ​Sphinx - The Sphinx documentation system.

Sphinx

Most UNIX distributions have a package for Sphinx. For manual installation refer to the ​Install Page on the Sphinx website.

Windows users can find detailed instructions on the ​Sphinx Website.

Getting Source

The source is located at:

Building

Each document can be built on its own by entering the directory and typing: 

  # waf configure
  # waf build