doc: Fix README path #540
Merged
doc: Fix README path #540
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
I've been testing and building doc with
cd doc
cmake -B builddir
ninja -C builddir
In this case README.md is two dirs up.
However, the "official" way, or our CI's way, to build doc is
cmake -B build-docs -S doc
cmake --build build-docs
With this, README.md is at the parent dir. I'd be nice if we can
write CWD independent way but this one needs a quick hot fix.
Signed-off-by: Yasushi SHOJI <yashi@spacecubics.com>
Test the document build process for pull requests to ensure its success before merging. Signed-off-by: Yasushi SHOJI <yashi@spacecubics.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I've been testing and building doc with
In this case README.md is two dirs up.
However, the "official" way, or our CI's way, to build doc is
With this, README.md is at the parent dir. I'd be nice if we can write CWD independent way but this one needs a quick hot fix.