2.2.6 Generating html documentation

2.2.5 Compiling (Prev)         2.3 Running a simulation (Next)

The html documentation that you are reading was generated using the doxygen documentation utility. The simpatico git repository contains all of the source files required to construct this docuentation (some of which is extracted from comments in the C++ source files), but does not contain the resulting html files.

Generating documentation

If the doxygen program is installed on your machine, you can regenerate a local copy of the html documentation. To check whether doxygen is installed, enter

> which doxygen

from the command line. If a valid path to a file named doxygen is returned, then doxygen is already installed. If doxygen is not installed, install it before proceeding, either using an appropriate package manager or by downloading from the doxygen web page.

Once doxygen is installed, simply change directory to the simpatico/ root directory and enter

> make html 

The resulting html files will be installed in the simpatico/doc/html/ directory.

Reading the documentation

The main page of the html documentation is a file named doc/html/index.html. To begin reading your local copy of the documentation, simply open this file in any web browser. To read the documentation on a linux system using the firefox browser, enter

> firefox doc/html/index.html

from the simpatico/ root directory. On a Mac, on can instead use the "open" command to open this file with the default browser, by entering

> open doc/html/index.html

from a terminal. Alternatively, one can use the Finder to navigate to the simpatico/doc/html folder, double click on any file in that directory with an *.html file extension, and then click on the "main page" button in the upper left to go to the main page (i.e., the index.html page).

The text of the main manual pages, including the page you are now reading, is contained in a set of files with file extension *.dox in the doc/manual directory. These are written in plain text with a few formatting commands, and can also be read with any text editor. Files in the src/ directory with the file extension *.dox or *.mod contain other parts of the doxygen documentation. In addditional, API documentation for each C++ class and function is extracted by doxygen from documentation blocks in every C++ header file.

Cleaning up

To delete all html documentation from the doc/html directory and start over, enter

> make clean-html

from the simpatico/ root directory.

2.1 Getting the Source Code (Prev)         2 User Guide (Up)         2.3 Running a simulation (Next)