Jump to: navigation, search

Difference between revisions of "ETrice/Development/BuildingDocumentation"

(New page: The eTrice documentation is LaTex based. The sources are contained in the doc folder. The main document is etrice-doc.tex. All documents included therein will constitute the contents of th...)
 
Line 1: Line 1:
 +
= Building the eTrice Documentation =
 
The eTrice documentation is LaTex based.
 
The eTrice documentation is LaTex based.
 
The sources are contained in the doc folder. The main document is etrice-doc.tex.
 
The sources are contained in the doc folder. The main document is etrice-doc.tex.

Revision as of 09:24, 8 April 2013

Building the eTrice Documentation

The eTrice documentation is LaTex based. The sources are contained in the doc folder. The main document is etrice-doc.tex. All documents included therein will constitute the contents of the documentation.

The Ant script build.xml builds from the Tex sources

  • a PDF manual
  • HTML pages
  • the Eclipse help table of contents

Prerequisites of the build are

Note: The LaTex Ant task can be defined also directly inside Eclipse: Preferences > Ant > Runtime > Tasks. Before doing so you will have to add the classpath to the ant_latex jar in the corresponding tab (under Global Entries).