diff --git a/README.md b/README.md index d74936dc6c0..bd24ca0f644 100644 --- a/README.md +++ b/README.md @@ -28,8 +28,9 @@ Note: English version API docs are generally docstrings in [PaddlePaddle/Paddle] ``` cd docs mkdir output - bash docs-build.sh -f absolute_path_docs + bash docs-build.sh -f "$(pwd)" ``` + Run this from the cloned repository root (the directory containing `docs-build.sh`), not the nested `docs/` directory. - step3: preview docs The output of docs will be generated in docs/output. diff --git a/README_cn.md b/README_cn.md index 753ad6be6b8..fbb3751cc79 100644 --- a/README_cn.md +++ b/README_cn.md @@ -27,8 +27,9 @@ docs 是 [PaddlePaddle 官网文档](https://www.paddlepaddle.org.cn/documentati ``` cd docs mkdir output - bash docs-build.sh -f absolute_path_docs + bash docs-build.sh -f "$(pwd)" ``` + 请在克隆的仓库根目录(即 `docs-build.sh` 所在目录)运行此命令,不要进入仓库内的 `docs/` 子目录。 - step3: preview docs 输出的文件会保存在 docs/output 路径下。 diff --git a/README_ja.md b/README_ja.md index 8b0978a1e82..223d6322d03 100644 --- a/README_ja.md +++ b/README_ja.md @@ -28,8 +28,9 @@ ``` cd docs mkdir output - bash docs-build.sh -f absolute_path_docs + bash docs-build.sh -f "$(pwd)" ``` + このコマンドは、リポジトリ内の `docs/` サブディレクトリではなく、`docs-build.sh` があるリポジトリのルートディレクトリで実行してください。 - step3: preview docs docs の出力は docs/output に生成されます。