Subject: Re: [boost] [GSoC] [Boost.Hana] Formal review request
From: Louis Dionne (ldionne.2_at_[hidden])
Date: 2014-07-28 20:26:46
Louis Dionne <ldionne.2 <at> gmail.com> writes:
> Edward Diener <eldiener <at> tropicsoft.com> writes:
> > [...]
> > A separate branch with the latest full documentation , maybe called
> > 'doc' might be clearer.
> There is such a branch, and it's called `gh-pages`. It's the way of doing
> things for projects on GitHub. The problem with providing the documentation
> _only_ through a branch is that you have to check it out (and hence overwrite
> the current working directory) to see it. So what I did is create such a
> branch and then make it available through a submodule, so you can check out
> that branch in a subdirectory.
Okay, so I made some changes and here's how it works now:
1. If you clone the repository as instructed in the README, everything
2. If you clone the repository and then just checkout the submodule, but
not at its latest version, you get an empty directory with a README
telling you exactly the commands to get the latest documentation.
3. When I release stable versions of the library, the default checkout
of the documentation submodule will be the documentation for that
version of the library instead of an empty directory with a README,
as one would expect.
Boost list run by bdawes at acm.org, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk