RippeR37/libbase

GLOG user guide is not visible in online documentation

RippeR37 opened this issue · 1 comments

When opening the documentation on GitHub Pages, then navigating to Logging page, the GLOG's user guide section is empty.

This seems to be reproducing only when building the documentation with sphinx-multiversion (currently only on CI/GitHub Workflow) and does NOT happen when building it locally.

After some debugging, it seems that the reason for this is that sphinx-multiversion uses git archive to "check-out" different branches and tags of the repository and this tool doesn't support checking-out submodules, so the README file from GLOG library is simply not accessible in that setup, hence the empty section.