Re: [Boost-docs] GitHub no longer renders html

Subject: Re: [Boost-docs] GitHub no longer renders html
From: Paul A. Bristow (pbristow_at_[hidden])
Date: 2016-10-07 09:13:21

> -----Original Message-----
> From: Boost-docs [mailto:boost-docs-bounces_at_[hidden]] On Behalf Of Stefan Seefeld
> Sent: 06 October 2016 19:00
> To: Discussion of Boost Documentation
> Subject: Re: [Boost-docs] GitHub no longer renders html
> 
> On 06.10.2016 13:44, Paul A. Bristow wrote:
> 
> [...]
> > I can see how to just *copy the generated /html* to a BoostGSoc15.github.io/fixed_point, but the build using Quickbook
> assumes that
> > is in the Boost tree to get the icon, navigation and admonitions icons etc, so it would not work 'as is'.
> >
> > I would like to just rebuild the docs and have the index.html redirect to the
> >
> > https://github.com/BoostGSoC15/fixed_point/index.html
> >
> > This sounds the Right Thing to Do, but I can't see how to do it.
> 
> I'm not sure about "the Right Thing", as I never build anything "in
> tree". In fact, I believe that building a stand-alone documentation tree
> is very useful for example because it allows to be packaged and
> installed separately.

I conclude that the nub of the problem with the docs as built is that there are very many links to code, for example, "The C++ code
is at ... " links, and that means you need to know where the file will be.  When the thing is in the final Boost tree structure,
that works fine, but during development and review, these files are in ones GitHub repos.

I've played with GitHub pages, pushing just the /html but that doesn't give these links. Perhaps I need to copy the whole repos ?

However, the combination of PDF version for the quick reviewers, and to clone the whole repos to the readers machine seems a
satisfactory compromise.

Thanks.

Paul

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