Re: [boost] [docs] Documentation on Github?

Subject: Re: [boost] [docs] Documentation on Github?
From: Rene Rivera (grafikrobot_at_[hidden])
Date: 2017-09-18 00:39:46

On Sun, Sep 17, 2017 at 4:57 PM, Vladimir Batov via Boost <
boost_at_[hidden]> wrote:

>
> On 09/17/2017 09:55 PM, John Maddock via Boost wrote:
>
>> On 17/09/2017 10:14, Andrey Semashev via Boost wrote:
>>
>>> On 09/17/17 11:02, John Maddock via Boost wrote:
>>>
>>>> I notice that a few libraries are serving their documentation pages on
>>>> github, for example http://boostorg.github.io/quic
>>>> kbook/doc/html/index.html How is this being done?
>>>>
>>>
>>> You can create a gh-pages branch in your repository and its contents
>>> will be rendered on github.io.
>>>
>>> https://help.github.com/articles/user-organization-and-
>>> project-pages/#project-pages
>>>
>>
>> Nod.  I realise that, but I had to make some changes to the source/build
>> process to make all the links work, plus it's a manual process to merge and
>> push stuff to the gh-pages branch, I wondered if anyone had succeeded in
>> automating it?
>>
>
> It does not have to be the gh-pages branch anymore. Docs can be generated
> from the master. Go to Settings. The GitHub Pages section. Select "Source".

I prefer to put such docs in an entirely different repo. So as not to bloat
the main repo with documentation when people do clones.

-- 
-- Rene Rivera
-- Grafik - Don't Assume Anything
-- Robot Dreams - http://robot-dreams.net
-- rrivera/acm.org (msn) - grafikrobot/aim,yahoo,skype,efnet,gmail