Re: [Boost-docs] [boost.test] Documentation update of master

Subject: Re: [Boost-docs] [boost.test] Documentation update of master
From: John Maddock (jz.maddock_at_[hidden])
Date: 2015-07-07 12:26:04

On 07/07/2015 08:29, Raffi Enficiaud wrote:
> Le 06/07/15 18:30, John Maddock a écrit :
>>
>>
>> On 06/07/2015 14:50, Raffi Enficiaud wrote:
>>> Le 03/07/15 17:39, Raffi Enficiaud a écrit :
>>>> Hi all,
>>>>
>>>> Gennadiy just merged the develop version to master. I was wondering if
>>>> the doc of the master branch of boost.test is planned to appear here
>>>> http://www.boost.org/doc/libs/master/doc/html/
>>>>
>>
>> I would guess that would be no - that page contains the quickbook docs
>> that all built together as "one big book".  That's maintained for legacy
>> reasons, but does not actually scale very well at all.
>>
>> Just my 2c.... John.
>
> Thanks, who may I ask then?
>

Sorry I'm not sure what you're asking - do you want/need to have your 
docs in that "one big build"?   If so then you need to integrate your 
docs into the xml under boost-root/doc/src/boost.xml, check it works 
(this can take a long time!) then submit a PR for the change.

But like I said, adding more stuff to that "one big build" doesn't 
scale, and doesn't work well as we move to a more modular structure.

One simple alternative is to place the generated docs under version 
control in Git and then they'll show up on the website when a release is 
made (not before, and there's no preview on Github, unlike what we had 
with svn).

I think there are some scripts somewhere that will build quickbook docs 
on demand for a release without needing to commit docs to Git, but I'm 
afraid I don't know anything about that.

Hopefully someone will chime in with more info, John.