Re: [boost] [lexical-cast] Help with documentation required

Subject: Re: [boost] [lexical-cast] Help with documentation required
From: Daniel James (dnljms_at_[hidden])
Date: 2011-07-20 10:06:39

On 20 July 2011 13:05, Antony Polukhin <antoshkka_at_[hidden]> wrote:
> I've added Qickbook documentation for lexical_cast to
> libs/conversion/doc/lexical_cast.qbk and a Jamfile.v2 file to build
> it. Meanwhile, there is an old HTML documentation for lexical_cast in
> libs/conversion/lexical_cast.htm and file libs/conversion/index.html
> references it.
>
> The question is: How shall I update the lexical_cast.htm/index.html,
> doc/html/ folder?

It's a bit awkward since lexical_cast is in some ways treated as a
library in it's own right (e.g. it's included in the library list) but
doesn't have its own directory. I think it's too late to change that.
Since lexical_cast.htm is linked to from the library list, it's
effectively lexical_cast's permanent location so it should stay and
redirect to the new location (you can see examples of how to do this
in most libraries' index.html files). libs/conversion/index.html
should probably just be changed to link directly to the new location.

You need to decide whether you want it to be included in the combined
documentation, or remain standalone in the library's directory. If you
let me know, I'll sort out adding it. Unless you want to check the
generated documentation into subversion yourself, like some libraries
do - there's been some debate on that issue in the '[fusion] html docs
woes' thread.

John handles the pdf generation, he usually sorts it out towards the
end of the release cycle. You usually just need to check it's okay
when he asks for feedback.