boost/test
2
0
Fork 0
mirror of https://github.com/boostorg/test.git synced 2026-01-24 18:32:30 +00:00
Code Issues Projects Releases Wiki Activity

Readme on how to get started with the doc

Browse Source
This commit is contained in:
Raffi Enficiaud
2015-01-08 17:35:39 +01:00
parent eed7e98857
commit c6c87f4fbd
1 changed files with 50 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
doc/README.txt Normal file
View File

@@ -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
---------------