[Developers] HTML documentation

Barry Wardell barry.wardell at aei.mpg.de
Tue May 25 11:26:35 CDT 2010


Hi,

Attached is a patch which enables support for compiling HTML versions of 
the Cactus documentation. It adds new build targets:

ReferenceManualHTML
MaintainersGuideHTML
UsersGuideHTML
*-ThornDocHTML
*-ArrangementDocHTML
ThornDocHTML
ArrangementDocHTML
ThornGuideHTML

Which are HTML equivalents of the existing doc targets. This makes use 
of the small new scripts lib/sbin/ArrangementDocHTML and 
lib/sbin/ThornDocHTML which must be made executable after applying the 
patch.

This patch also introduces a small new script, lib/sbin/ConvertFigures, 
(again this must be made executable after applying the patch) which 
automates the process of converting figures to the correct format for 
htlatex.

Finally, it makes some changes to doc/latex/cactus.sty to improve the 
rendering of the HTML. It also modifies the Reference Guide to produce a 
more consistent result (any cases of the CCTKFunc macro were updated to 
use the newer FunctionDescriptionEntry).

For an example of the HTML output produced, see: 
http://www.aei.mpg.de/~barry/

Ian Hinder has been testing this patch.

Barry


--- StripMime Report -- processed MIME parts ---
multipart/mixed
  text/plain (text body -- kept)
  application/x-gzip
---


More information about the Developers mailing list