libbase icon indicating copy to clipboard operation
libbase copied to clipboard

GLOG user guide is not visible in online documentation

Open RippeR37 opened this issue 3 years ago • 1 comments

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

RippeR37 avatar Jul 30 '22 14:07 RippeR37

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.

  • https://github.com/Holzhaus/sphinx-multiversion/issues/48
  • https://git-scm.com/docs/git-archive

RippeR37 avatar Jul 30 '22 14:07 RippeR37