[docs] Documentation on Github?
I notice that a few libraries are serving their documentation pages on github, for example http://boostorg.github.io/quickbook/doc/html/index.html How is this being done? Thanks! John. --- This email has been checked for viruses by AVG. http://www.avg.com
On 17/09/2017 10: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/quickbook/doc/html/index.html How is this being done? Everything is explained here: https://help.github.com/articles/configuring-a-publishing-source-for-github-... For quickbook it seems to be /doc/html from gh-pages branch.
.
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/quickbook/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/#projec...
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/quickbook/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/#projec...
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? --- This email has been checked for viruses by AVG. http://www.avg.com
On 17.09.2017 07:55, 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/quickbook/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/#projec...
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?
Yeah, Boost.Python does that (http://boostorg.github.io/python). Have a look at its Travis-CI logic: https://github.com/boostorg/python/blob/develop/.travis.yml https://github.com/boostorg/python/blob/develop/.ci/upload_docs.sh (One of the automated builds generates new docs, and pushes new content into the `gh-pages` branch. It even does that for `master` and `develop` separately, to maintain two sets of docs at http://boostorg.github.io/python/doc/html/index.html and http://boostorg.github.io/python/develop/doc/html/index.html respectively.) Stefan -- ...ich hab' noch einen Koffer in Berlin...
On 17 September 2017 at 12:55, John Maddock via Boost
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?
This is my script for updating the branch: https://github.com/boostorg/quickbook/blob/develop/build/publish-docs I guess it could be run automatically, but I prefer to run it manually when I wish to. There is a special case for index.html because gh-pages branch has a different redirect.
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/quickbook/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/#projec...
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".
On Sun, Sep 17, 2017 at 4:57 PM, Vladimir Batov via Boost < boost@lists.boost.org> 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
On 9/17/17 5:39 PM, Rene Rivera via Boost wrote:
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.
LOL - I like to get the whole package including the docs. I hate to have go online and look around for the docs someplace else then figure out were to put them on my own machine. Ideally I'd like the to have the readable docs and library as a unit so that it's ways in sync. That is when I delete or update the package everything is in sync. Robert Ramey
participants (8)
-
Andrey Semashev -
Daniel James -
John Maddock -
Nicolas -
Rene Rivera -
Robert Ramey -
Stefan Seefeld -
Vladimir Batov