GENESIS: Documentation

Related Documentation:

userdocs_cron

The GENESIS documentation system consumes many resources, particularly memory and cpu time, when being rebuilt. Rebuilding can take a considerable time, particularly on a single processor. For example, rebuilding Levels 1 and 2 takes at least ten minutes, whereas, rebuilding all seven levels takes at least 40 minutes. For these reasons the documentation build is an automated operation. The userdocs package comes with a cron script that can be set up to run at periodic intervals to keep your documentation up to date.

Configuration

To configure the userdocs_cron script you must construct a YAML file with the following options:

• MAILTO: An email recipient to send an email to on completion of the job.
• MAILFROM: An email address from which to send a completion email.
• HTMLDIR: A directory which will hold your userdocs html data directory to be served from the internet.
• OUTPUTDIR: A directory to write the output log data.
• URL: An http link which serves the test harness output (for an example see PClamp).

Example configuration file