How to build the documentation

From Rigs of Rods Wiki

Jump to: navigation, search

Contents

  Tools Required:

Note: the latest documentation is always available under http://docs.rigsofrods.com/ only if you want to work on the documentation itself, its advised to read this page.

Doxygen

Releases

  • Mac OS X (Tiger & Leopard)
  • Windows (versions 95 through Vista)
  • Linux i386
  • Source Installers and source code for all of the above can be found here.


Instructions for building and installing the source on other operating systems (such as Unix) can be found here.
Windows Users:  If you need somebody to hold your hand to install from a setup file, you can go here.

Using Doxygen:

The general idea

  • Set a working directory for doxygen
  • Tell Doxygen where the source files are
  • Tell Doxygen where to output its findings
  • Check the output of doxygen to make sure everything worked properly

Supported Output Formats

  • HTML -- recommended
  • LaTeX
  • Man pages -- recommended
  • RTF
  • XML
  • QT Help Project (.qhp)
  • Compiled HTML (.chm) -- recommended, but not always supported by Windows Vista or Windows 7
  • QT Compressed help (.qch)
  • PDF
  • PostScrpt 

For PostScript and PDF output, see here, as extra steps are required.

Using the Doxygen GUI 

Simply look here. Yes, its the Mac OS X GUI, but the Windows style GUI is pretty similar.

Using a Command Line With Doxygen

Simply look here.

Advanced Configuration

Look here

building the RoR documentation under windows

  1. open the file doc\Doxyfile.source.windows.conf with "start menu->programs->doxygen->Doxywizard" then file->open.
  2. go to "run" tab and press "Run doxygen" button
  3. when it finished, navigate to doc\api\html and open the index.html file :)
Retrieved from "http://wiki.rigsofrods.com/pages/How_to_build_the_documentation"
Personal tools