diff --git a/.gitmodules b/.gitmodules index 4b9301680af752a7849222d64d459d1239314b04..f5002ee61362c49d000a9e1abf8f933eac9e96c2 100644 --- a/.gitmodules +++ b/.gitmodules @@ -1,15 +1,6 @@ [submodule "external/book"] path = external/book url = https://github.com/PaddlePaddle/book -[submodule "external/Anakin"] - path = external/Anakin - url = https://github.com/PaddlePaddle/Anakin -[submodule "external/paddle-mobile"] - path = external/paddle-mobile - url = https://github.com/PaddlePaddle/paddle-mobile [submodule "external/Paddle"] path = external/Paddle url = https://github.com/PaddlePaddle/Paddle -[submodule "external/models"] - path = external/models - url = https://github.com/PaddlePaddle/models diff --git a/README.md b/README.md index 3cc716e7ed482960909cf66be7d19c9aaa790e25..1c35448f315fd220a709dde6ddb00c38f65141e7 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ English | [简体中文](./README_cn.md) FluidDoc consolidates all the documentations related to Paddle. It supplies the contents to PaddlePaddle.org via CI. # Architecture -FluidDoc submodules Paddle, Book, Models, Mobile and Anakin under `external` folder. All submodules should be put under `external` as standard practice. +FluidDoc submodules Paddle, Book under `external` folder. All submodules should be put under `external` as standard practice. FluidDoc then uses them as references to load up the documents. The FluidDoc constructs the whole doc-tree under the `FluidDoc/doc/fluid` folder. The entry point is `FluidDoc/doc/fluid/index_cn.rst` and `FluidDoc/doc/fluid/index_en.rst` @@ -22,7 +22,7 @@ To preview documents constructured by FluidDoc. Please follow the [regular previ # Publish New release 1. Checkout a new release branch. The branch name should follow `release/` 1. Update the documentations on the submodules or within FluidDoc -1. Make sure all the submodules are ready for release. Paddle, book, model, mobile and Anakin should all have stable commits. Note: Paddle repo should update the API RST files accordinly if Paddle changes the included module/classes. +1. Make sure all the submodules are ready for release. Paddle, book should all have stable commits. Note: Paddle repo should update the API RST files accordinly if Paddle changes the included module/classes. 1. Update the submodules under `external` folder and commit the changes. 1. Git push the branch to Github, Travis CI will start several builds to publish the documents to the PaddlePaddle.org server 1. Please notify the PaddlePaddle.org team that the release content is ready. PaddlePaddle.org team should enable the version and update the default version to the latest one. PaddlePaddle.org should also update the search index accordingly (Until the search server is up) diff --git a/README_cn.md b/README_cn.md index 8b6e62cf2d5fe3baf74371504ccfc938999f5398..c59f886b55cd5d5f5dddfd92b425b775c7773efa 100644 --- a/README_cn.md +++ b/README_cn.md @@ -9,7 +9,7 @@ FluidDoc包含了所有PaddlePaddle相关的文档,它通过CI系统为PaddleP # 架构 -FluidDoc将Paddle, Book, Models, Mobile and Anakin作为子模块,并放置在 `external` 目录下。按照标准做法,所有的子模块应当置于`external` 目录下 +FluidDoc将Paddle, Book 作为子模块,并放置在 `external` 目录下。按照标准做法,所有的子模块应当置于`external` 目录下 FluidDoc通过引用这些子模块来加载这些Repo中的文档。FluidDoc在 `FluidDoc/doc/fluid` 目录下构建了文档的整体树形结构。可以分别在 `FluidDoc/doc/fluid/index_cn.rst` 和 `FluidDoc/doc/fluid/index_en.rst` 查看。 @@ -26,7 +26,7 @@ FluidDoc 需要Paddle Repo的python模块去编译生成API文档。但由于Pad ## 发布新的分支 1. 创建一个新的分支,此分支的名字应遵循`release/` 1. 在FluidDoc和子模块中更新文档 -1. 确认所有的子模块中处于发布就绪的状态。Paddle, book, model, mobile and Anakin 应全部有稳定的commit +1. 确认所有的子模块中处于发布就绪的状态。Paddle, book 应全部有稳定的commit 请注意:如果Paddle Repo更改了module/classes,涉及API文档的RST文件应当也被更新 1. 在 `external` 中更新文件然后commit文档变更 1. 将这个分支push到Github,Travis CI将会启动几项构建工作以把文档发布到PaddlePaddle.org的服务器 diff --git a/external/Anakin b/external/Anakin deleted file mode 160000 index beec126e4cfe762e4b6b542496069323dca35ee7..0000000000000000000000000000000000000000 --- a/external/Anakin +++ /dev/null @@ -1 +0,0 @@ -Subproject commit beec126e4cfe762e4b6b542496069323dca35ee7 diff --git a/external/models b/external/models deleted file mode 160000 index bc0200b971b0e951b4a3f13822a1e1db33388b29..0000000000000000000000000000000000000000 --- a/external/models +++ /dev/null @@ -1 +0,0 @@ -Subproject commit bc0200b971b0e951b4a3f13822a1e1db33388b29 diff --git a/external/paddle-mobile b/external/paddle-mobile deleted file mode 160000 index 2c088e20d8083accacaf2057bc35531ac7fba7ce..0000000000000000000000000000000000000000 --- a/external/paddle-mobile +++ /dev/null @@ -1 +0,0 @@ -Subproject commit 2c088e20d8083accacaf2057bc35531ac7fba7ce