Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

GLOG user guide is not visible in online documentation #1

Closed
RippeR37 opened this issue Jul 29, 2022 · 1 comment
Closed

GLOG user guide is not visible in online documentation #1

RippeR37 opened this issue Jul 29, 2022 · 1 comment
Labels
bug Something isn't working documentation Improvements or additions to documentation external Bug related to external component, not possible to fix or workaround within the project on hold Issue currently put on hold

Comments

@RippeR37
Copy link
Owner

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

@RippeR37 RippeR37 assigned RippeR37 and unassigned RippeR37 Jul 29, 2022
@RippeR37 RippeR37 added bug Something isn't working documentation Improvements or additions to documentation external Bug related to external component, not possible to fix or workaround within the project on hold Issue currently put on hold labels Jul 29, 2022
@RippeR37
Copy link
Owner Author

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.

@RippeR37 RippeR37 closed this as not planned Won't fix, can't repro, duplicate, stale Jul 30, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation external Bug related to external component, not possible to fix or workaround within the project on hold Issue currently put on hold
Projects
None yet
Development

No branches or pull requests

1 participant