wiki:Docs/Build
Notice: We have migrated to GitLab launching 2024-05-01 see here: https://gitlab.rtems.org/

Version 6 (modified by Amar Takhar, on 01/19/16 at 15:19:03) (diff)

Notes about other targets and dependencies.

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.

Extras

These dependencies are not required by default but are used for other targets.

Target Dependency
pdfTeX (pdflatex)
htmlsingleNode ​inliner

Sphinx

Note: Version 1.3 is the minimum version of Sphinx required.

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

This will build the default html target which is several split files.

Targets

Target Result
--pdfBuild PDF
--htmlsingleBuild a Single HTML file