Version 4 (modified by nivy, on Dec 9, 2018 at 6:52:38 PM) (diff)


New Manual

Table of Contents

  1. New Manual

A new manual is created by adding the manual's directory to the top level directory of the RTEMS Documentation Repository.

Add the manual's directory to the top level waf script file's build_all list.

In this example, the new manual is called new-manual.

Create a file in the manual directory containing:

import sys, os

from conf import *

version = '4.11.0'
release = '4.11.0'

project = "RTEMS New Manual"

latex_documents = [
        ('index', 'new-manual.tex', u'RTEMS New Manual', u'RTEMS Documentation Project', 'manual'),


  1. The file is a Python piece of code.
  2. The versions are manually set.
  3. The project variable is the name that appears in the HTML output.
  4. The latex_documents list is a truple of values needed to build a PDF.

Create an index.rst file based on:

.. comment SPDX-License-Identifier: CC-BY-SA-4.0

RTEMS New Manual

RTEMS New Manual

 | COPYRIGHT (c) 2016.
 | Makers of New Manuals

The authors have used their best efforts in preparing this material.  These
efforts include the development, research, and testing of the theories and
programs to determine their effectiveness.  No warranty of any kind, expressed
or implied, with regard to the software or the material contained in this
document is provided.  No liability arising out of the application or use of
any product described in this document is assumed.  The authors reserve the
right to revise this material and to make changes from time to time in the
content hereof without obligation to notify anyone of such revision or changes.

The RTEMS Project is hosted at  Any inquiries concerning
RTEMS, its related support components, or its documentation should be directed
to the Community Project hosted at

.. topic:: RTEMS Online Resources

  ================  =============================
  Bug Reporting
  Mailing Lists
  Git Repositories
  ================  =============================

.. toctree::
        :maxdepth: 5


*       :ref:`genindex`
*       :ref:`search`


1.Provide chapters preface.rst, overview.rst and body.rst.