Re: [Boost-docs] interface between library documentation and Boost website

Subject: Re: [Boost-docs] interface between library documentation and Boost website
From: Paul A. Bristow (pbristow_at_[hidden])
Date: 2015-07-16 08:55:33

> -----Original Message-----
> From: Boost-docs [mailto:boost-docs-bounces_at_[hidden]] On Behalf Of Robert Ramey
> Sent: 15 July 2015 18:27
> To: Discussion of Boost Documentation
> Subject: Re: [Boost-docs] interface between library documentation and Boost website
> 
> On 7/15/15 9:44 AM, Paul A. Bristow wrote:
> 
> >
> > PS It is sad that on github, clicking on the index.html file shows the
> > raw html, not what you see using a browser. There is a github.io bit
> > of javascript, but it is very partially successful :-(
> >
> 
> There's a fix for this.
> 
> http://htmlpreview.github.io/?https://github.com/robertramey/safe_numerics/master/doc/html/inde
> x.html
> 
> will open the html directory right in github.

In my experience, it doesn't really work on complicated Boost library documentation with lots of
links :-(

I'll look into RawGit <https://rawgit.com/> after Rene Rivera's recommendation - it looks fine on
prefed - but it's pretty simple and there aren't many links.

Paul

PS My experience with rewriting some documentation is that it is better to simply cut and paste from
the displayed html.  If you are knowledgable about the library

PPS

So what's the entry point ? A single top-level index.html file in the doc/ directory ?

I'd favour a redirection in both /libs/yourlibrary/index.html and in
/libs/yourlibrary/doc/index.html
to a folder /libs/yourlibrary/doc/html/ containing 'real' index.html

Otherwise, no restrictions.

---
Paul A. Bristow
Prizet Farmhouse
Kendal UK LA8 8AB
[phone]