Skip to content

[Docs] Clarify the documentation build root - #7935

Open
Daiyuanranfeng wants to merge 1 commit into
PaddlePaddle:developfrom
Daiyuanranfeng:docs/clarify-docs-build-root
Open

Daiyuanranfeng wants to merge 1 commit into
PaddlePaddle:developfrom
Daiyuanranfeng:docs/clarify-docs-build-root

Conversation

@Daiyuanranfeng

Copy link
Copy Markdown

Summary

Use $(pwd) in the English, Chinese, and Japanese build examples and clarify that -f expects the cloned repository root, not its nested docs/ directory.

Refs #6232 (build-command clarification only). This does not change the build script or address generated files and ownership.

Verification

  • git diff --check and prek run --files README.md README_cn.md README_ja.md passed.
  • bash -n docs-build.sh passed. Using a stubbed Docker command, verified that the example mounts the repository root at /FluidDoc and its output/ at /docs. No full Docker/Sphinx build was run.

Signed-off-by: Ziqiang Zhang <daiyuanranfeng@openatom.club>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant