Name

mk_docbook_html — Generate html documentation

Synopsis

mk_docbook_html SOURCE=source_file

Options

SOURCE=source_file

specifies the DocBook XML source file to process

STYLESHEET=xsl_file

specifies the XSL stylesheet for generating html. Defaults to $MK_DOCBOOK_XSL_DIR/xhtml/profile-chunk.xsl.

IMAGES=image_dir

specifies the directory from which to copy images used in the generated html. Defaults to $MK_DOCBOOK_XSL_DIR/images.

INSTALLDIR=install_dir

specifies the directory where the generated documentation will be placed. Defaults to $MK_HTMLDIR.

INCLUDES=source_list

specifies a list of additional xml files that might be included by source_file, such as by XInclude.

DEPS=deps

specifies any additional dependencies needed to generate the documentation

Description

Processes the specified source file with XSLT to produce html documentation.

To use this function, you must use mk_check_docbook in a configure section of your project, and it must succeed. You can test if DocBook processing is available with mk_have_docbook. This function will fail if it is not.