Building library reference pages

From MCRL2

The library reference pages are built nightly using Doxygen and then uploaded to the mCRL2 webserver. For this, a Bash script has been created that resides in the trunk/doc/doxy/ directory of the mCRL2 repository. It can generate the pages for both online and offline viewing. This page contains instructions for generating the pages for offline viewing on a local machine, which is convenient for developers when editing the pages. Please note however, that the offline pages will not have the same style (look and feel) as the online pages for technical reasons.

Requirements

For building the library reference pages, you will need to install the latest stable version (>= 1.5.6) of Doxygen.

Instructions

• Go to the trunk directory of your mCRL2 distribution.
  

Note: This step is important! The following commands can only be executed from the trunk directory!

• Execute the following command:

./doc/doxy/generate_libref_website.sh -i

This returns a list of available libraries with corresponding IDs.

• Choose the ID of the library for which you want to generate the reference pages, say 5. Then execute the following command:

./doc/doxy/generate_libref_website.sh -l 5

• Doxygen messages are printed to the screen. Please try to fix any warnings and errors, if possible.
• The HTML output is generated in the following directory:

./build/doxy/[libname]/

where [libname] is a short name for the library for which reference pages were generated. This library contains a file index.html that you can open in any web browser.

Notes

• The script has a help function that can be accessed as follows:

./doc/doxy/generate_libref_website.sh -h

• You can pass multiple library IDs to the script as a comma-separated list. For example:

./doc/doxy/generate_libref_website.sh -l 2,4,6

• The script maintains its own list of libraries that it is aware of. This list can be edited by opening the script in a text editor and following the instructions in the comments.
• Other configuration options are also desribed in the script file.