HPX - High Performance ParalleX

PrevUpHomeNext

Setting up the HPX Documentation Tool Chain

The documentation for HPX is generated by the Boost QuickBook documentation toolchain. Setting up this toolchain requires to install several tools and libraries. Generating the documentation is possible only if all of those are configured correctly.

CMake Variables needed for the Documentation Toolchain

DOXYGEN_ROOT:PATH

Specifies where to look for the installation fo the Doxygen tool.

BOOSTQUICKBOOK_ROOT:PATH

Specifies where to look for the installation fo the QuickBook tool. This tool usually needs to be built by hand. See the QuickBook documentation for more details on how to do this.

BOOSTAUTOINDEX_ROOT:PATH

Specifies where to look for the installation fo the AutoIndex tool. This tool usually needs to be built by hand. See the AutoIndex documentation for more details on how to do this. The documentation can still be generated even if the AutoIndex tool cannot be found.

XSLTPROC_ROOT:PATH

Specifies where to look for the installation of the libxslt package (and the xsltproc tool). Consult the documentation for your platform on how to make this package available on your machine.

DOCBOOK_DTD_ROOT:PATH

Specifies where to look for the installation of the docbook-xml-4.2 package. This usually needs to refer to the directory containing the file docbook.cat, which is part of this package.

DOCBOOK_XSL_ROOT:PATH

Specifies where to look for the installation of the docbook-xsl package. This usually needs to refer to the directory containing the file catalog.xml, which is part of this package.


PrevUpHomeNext