Repository navigation
[Docs] Clarify the documentation build root - #7935
Open
Daiyuanranfeng wants to merge 1 commit into
Open
Daiyuanranfeng wants to merge 1 commit into
Daiyuanranfeng wants to merge 1 commit into
Conversation
Signed-off-by: Ziqiang Zhang <daiyuanranfeng@openatom.club>
This file contains hidden or 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
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.
Summary
Use
$(pwd)in the English, Chinese, and Japanese build examples and clarify that-fexpects the cloned repository root, not its nesteddocs/directory.Refs #6232 (build-command clarification only). This does not change the build script or address generated files and ownership.
Verification
git diff --checkandprek run --files README.md README_cn.md README_ja.mdpassed.bash -n docs-build.shpassed. Using a stubbed Docker command, verified that the example mounts the repository root at/FluidDocand itsoutput/at/docs. No full Docker/Sphinx build was run.