From f929c25594a3375d6ff89b43c453c6b6efecc89b Mon Sep 17 00:00:00 2001 From: Jonathan Robie Date: Thu, 18 Mar 2010 14:12:25 +0000 Subject: Now using a Makefile, rather than ant. git-svn-id: https://svn.apache.org/repos/asf/qpid/trunk/qpid@924790 13f79535-47bb-0310-9956-ffa450edef68 --- doc/book/README.txt | 31 ++++++++++++++++++++----------- 1 file changed, 20 insertions(+), 11 deletions(-) (limited to 'doc') diff --git a/doc/book/README.txt b/doc/book/README.txt index e00667e575..2deb20a13b 100644 --- a/doc/book/README.txt +++ b/doc/book/README.txt @@ -3,22 +3,31 @@ original content was taken from the Apache Qpid Wiki. 1. Building the Documentation -To build the documentation, use ant: +You need the following to build the documentation: -$ ant +- Apache FOP, version 0.95 or higher +- Docbook 4.5 +- Docbook XSL stylesheets - I have tested with xsl-stylesheets-1.75.2 +- xsltproc +- xmllint -You need both ant and ant-trax, and xmllint (or another XInclude -processor - if you do not use xmllint, you must change build.xml). On -Fedora, you can get them using yum: +On many Linux machines, these can usually be installed from standard +repos. For instance, on Fedora they can be installed as follows: -$ sudo yum install ant ant-trax xmllint +$ sudo yum install fop docbook-dtds docbook-style-xsl libxslt libxml2 -The other tools that you need are in subdirectories: +After installing, use make to build the documentation: + +$ make + +By default, the Makefile builds a PDF. It supports the following +targets: + +pdf Make the PDF +html Make HTML pages +all Make both PDF and HTML +clean Delete the build and output directories -qpid/doc/book/docbook - Docbook 4.5 DTDs -qpid/doc/book/docbook-xsl - Docbook XSLT stylesheets -qpid/doc/book/lib/saxon - Saxon 6.5.3 XSLT processor -qpid/doc/book/lib/fop-0.95 - Apache FOP You will see quite a few error messages. Many of these are due to unresolved links, and these should go away. Many are due to the -- cgit v1.2.1