Clarification on using with submodules

[jkm]

I fail to understand how bootDoc works together with a gh-pages branch. Assuming bootDoc is a submodule in that branch. Then generating rdmd bootDoc/generate.d ../src won't work as the src/ is only in the master branch. I tried to verify how it is supposed to work using https://github.com/JakobOvrum/LuaD/ like this:

$ git clone https://github.com/JakobOvrum/LuaD.git
$ git checkout gh-pages
$ rdmd bootDoc/generate.d .. --extra=index.d

The last gives me: Error: cannot read file ../luad/all.d Error: cannot read file ../luad/state.d Error: cannot read file ../luad/base.d ...

[JakobOvrum]

You have to clone the LuaD/gh-pages branch inside LuaD/master. The gh-pages branch depends on the master branch, so two repositories have to be used. The directory docs is on the ignore list of the master branch for this purpose.

git clone https://github.com/JakobOvrum/LuaD.git
cd LuaD
git clone -b gh-pages https://github.com/JakobOvrum/LuaD.git docs
cd docs
rdmd bootDoc/generate.d .. --extra=index.d

Of course, this is only one option that LuaD happens to use, but you can of course pass any path to the generator tool.

[jkm]

I see. That explains my confusion. I assumed gh-pages is just a branch but I need to clone the complete repository again and switch to the gh-pages branch. Still I will see whether I can avoid the second clone somehow.