Re: [Boost-docs] boost-root/doc/test needed

Subject: Re: [Boost-docs] boost-root/doc/test needed
From: John Maddock (john_at_[hidden])
Date: 2008-07-30 17:57:05

Eric Niebler wrote:
> John Maddock wrote:
>>
>> Right, but I have to question the wizdom of having the main doc build
>>  depend on so many tools - we certainly haven't documented the
>> dependency on latex/dvips/gs have we?
>
> No. Where would that documentation go?

I don't know :-(

One of the other issues is that not having these tools installed doesn't 
cause the build to fail - you have to spot the error messages amoungst the 
1000's of lines of chaff that doxygen emits.  That's an issue for future 
releases as it would be very easy to ship Boost with incomplete accumulator 
docs.

>> - do we even have any instructions on how to set these up in our
>> user-config.jam's?
>
> They don't need to be configured. They just need to be in the path.

OK I'll give that a try.

>> Assuming these are for image/equation generation, I'd rather Eric did
>> what Boost.Math does and generate these locally and commit to SVN.
>> Then leave the centralised build for the "core" tools:
>> boostbook/quickbook etc.
>
> I thought about that, but Accumulators uses latex formulas differently
> than Boost.Math. The latex formulas are embedded in doxygen comments
> directly in the source code, right where they are used. Doxygen
> invokes latex/dvips/gs and generates png files and puts a link to
> them in the xml output. If I generated then by hand and checked them
> in, I'd have a maintenance problem. How do I make sure the
> (automatically generated) reference docs are pointing to the right
> png files?
>> Heaven only knows things are complex enough already!
>
> Agreed. Not sure what to do about it, though.

Me neither :-(

Some docs on the docs would be a start though I guess...

John.