Re: [boost] Writing documentation

Subject: Re: [boost] Writing documentation
From: Paul A. Bristow (pbristow_at_[hidden])
Date: 2013-02-02 12:02:56

> -----Original Message-----
> From: Boost [mailto:boost-bounces_at_[hidden]] On Behalf Of Borislav Stanimirov
> Sent: Saturday, February 02, 2013 4:44 PM
> To: boost_at_[hidden]
> Subject: Re: [boost] Writing documentation
> 
> On 02/02/2013 06:33 PM, Andrey Semashev wrote:
> > On Saturday 02 February 2013 18:08:19 Borislav Stanimirov wrote:
> >> On 02/02/2013 12:00 PM, Andrey Semashev wrote:
> >>> On Saturday 02 February 2013 11:46:19 Borislav Stanimirov wrote:
> >>>> I was wondering how one writes documentation.
> >>>
> >>> I found QuickBook to be the easiest tool for documenting Boost libraries.
> >>> You can find its docs on the site:
> >>>
> >>> http://www.boost.org/doc/libs/release/doc/html/quickbook.html
> >>
> >> Hi again,
> >>
> >> Perhaps you could help me a bit more?
> >>
> >> I tried creating a Jamfile.v2 for my book. Here it is:
> >>
> >> using quickbook ;
> >> xml mixin_doc : mixin.qbk ;
> >> boostbook mixin : mixin_doc ;
> >> install html ;
> >>
> >> It successfully generateates mixin_doc.xml but doesn't generate any
> >> html. Here's the output:
> >>
> >> warn: Unable to construct ./mixin
> >> ...found 7 targets...
> >> ...updating 4 targets...
> >> common.mkdir bin
> >> common.mkdir bin/gcc-4.6
> >> common.mkdir bin/gcc-4.6/debug
> >> quickbook.quickbook-to-boostbook bin/gcc-4.6/debug/mixin_doc.xml
> >> Generating Output File: bin/gcc-4.6/debug/mixin_doc.xml ...updated 4
> >> targets...
> >>
> >> Am I missing something?
> >
> > I'm not sure. Did you also install xsltproc and docbook packages as
> > described in the installation guide?
> >
> >
> Yes I did.
> 
>   $ dpkg --get-selections | grep -e docbook -e xsltproc
>   docbook        install
>   docbook-xml    install
>   docbook-xsl    install
>   xsltproc       install
> 
> I don't have doxygen though. Could that be the problem?

You don't need Doxygen unless you use it.

I think not all the versions of Docbook stuff work - strongly recommend using exactly these two
versions.

The standard nix install might not give these?

My user_config.jam has

using boostbook
  : "C:\\Program Files\\docbook\\docbook-xsl-1.77.1" # OK 23 Aug12
  # Contains eXtended Style Sheet programs.
  : "C:\\Program Files\\DocbookXML\\42" # dir exists and contains docbookx.dtd 4.2
  #  actually C:\Program Files\DocbookXML\42
  ;

(You should get a line generating file standalone_HTML_manifest)

HTH

Paul

PS Don't give up!  Once the pig is setup, Quickbook works fine ;-)

---
Paul A. Bristow,
Prizet Farmhouse, Kendal LA8 8AB  UK
[phone]  07714330204
pbristow_at_[hidden]