Re: [Boost-docs] Sphinx integration

Subject: Re: [Boost-docs] Sphinx integration
From: Paul A. Bristow (pbristow_at_[hidden])
Date: 2011-10-05 15:37:55

> -----Original Message-----
> From: boost-docs-bounces_at_[hidden] [mailto:boost-docs-bounces_at_[hidden]] On Behalf Of
> Dave Abrahams
> Sent: Wednesday, October 05, 2011 3:43 PM
> To: boost-docs_at_[hidden]
> Subject: Re: [Boost-docs] Sphinx integration

> on Wed Oct 05 2011, "Paul A. Bristow" <pbristow-AT-hetp.u-net.com> wrote:
> 
> >> -----Original Message-----
> >
> >> From: boost-docs-bounces_at_[hidden]
> >> [mailto:boost-docs-bounces_at_[hidden]] On Behalf Of Dave
> >> Abrahams
> >> Sent: Tuesday, October 04, 2011 11:35 PM
> >> To: boost-docs_at_[hidden]
> >> Subject: Re: [Boost-docs] Sphinx integration
 
> *reads*
> <exaggeration>   The need to escape "<" signs in Doxygen comments makes me ill </exaggeration>

What a delicate constitution ;-)

But anyway Doxygen comments don't usually have "<"  (it's only if you want to pin the comment to a
particular line).
And it comes out in your comment color, so you don't even 'see' it if you are reading C++.

> This PDF was produced by FOP, right?  It's horrible to look at (no offense).

Well I like it!  I even slightly prefer it to the html.  And it's a single file - easy to send, save
and store.
Well opinions vary, but whole point is that from Quickbook toolchain you get either or both.

 > Those links are broken

Ah yes - sorry - some are not in SVN  :-(
 
> Anyway, I confess that I find the presentation of Boost's HTML docs off-putting too.  Maybe I'm
just in a
> grouchy mood this morning.  Before I can even appreciate what's been done I think I might need to
> redesign Boost's stylesheet :(

I think we need to ask the *users* what *they* want to read.

We won't get a unanimous view I'm sure, but it should be a better guide than the developers
preferences.

Paul

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