From c6c87f4fbd28c92bf2249c680b41b2ea61887a7e Mon Sep 17 00:00:00 2001 From: Raffi Enficiaud Date: Thu, 8 Jan 2015 17:35:39 +0100 Subject: [PATCH] Readme on how to get started with the doc --- doc/README.txt | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) create mode 100644 doc/README.txt diff --git a/doc/README.txt b/doc/README.txt new file mode 100644 index 00000000..e2c1e934 --- /dev/null +++ b/doc/README.txt @@ -0,0 +1,50 @@ +This folder contains the documentation for the Boost.Test library. +Any contribution or submission to the library should be accompanied by the corresponding documentation. + +The format of the documentation uses [Quickbook]. + +How to build the documentation +============================== + + +Install Doxygen +--------------- +Part of the documentation needs [http://www.doxygen.org Doxygen]. Download and install it. `doxygen` should be accessible from the terminal. + +Download Docbook +---------------- +Quickbook needs docbook to be installed. Download and untar the docbook archives: + +* Docbook XSL that can be found here: +* Docbook XML that can be found here: + +These two archives are supposed to be untarred to `$docbook_xsl_directory` and `$docbook_xml_directory` respectively. + + +Download xsltproc +----------------- +This program is needed by docbook, in order to be able to transform XMLs into HTMLs. +`xsltproc` should be accessible from the command line. + + +Construct bjam +-------------- + +Simply by typing in a terminal: +`` +> cd $boost_root +> ./bootstrap.[sh|bat] + +`` + +Build the documentation +----------------------- + +`` +> cd $boost_root/libs/test/doc +> ../../../b2 -sDOCBOOK_XSL_DIR=$docbook_xsl_directory -sDOCBOOK_DTD_DIR=$docbook_xml_directory +`` + + +Recommendations +---------------