wiki:Docs/Build

Version 1 (modified by Amar Takhar, on Jan 18, 2016 at 12:40:49 AM) (diff)

Add a simple page on building the docs.

Build Documentation

This page explains how to build the documentation from source.

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.

Building

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

  # waf configure
  # waf build

There is a general book document that will include all documentation available into one giant book.

Getting Source

The source is located at: