未验证 提交 bd86ac51 编写于 作者: J Jeff Wang 提交者: GitHub

Update README.md

上级 ecb271b2
...@@ -11,6 +11,10 @@ When a release branch is pushed to Github, Travis-CI will start automatically to ...@@ -11,6 +11,10 @@ When a release branch is pushed to Github, Travis-CI will start automatically to
## Note: ## Note:
FluidDoc needs Paddle python module to compile API documents. Unfortunately, compiling Paddle python module takes longer time Travis CI permits. Usually Travis CI will fail due because of timeout. That's why there three jobs on Travis, two of them are to build libraries. Once the libraries are cached on the Travis, next build will be a lot faster. FluidDoc needs Paddle python module to compile API documents. Unfortunately, compiling Paddle python module takes longer time Travis CI permits. Usually Travis CI will fail due because of timeout. That's why there three jobs on Travis, two of them are to build libraries. Once the libraries are cached on the Travis, next build will be a lot faster.
## Preview with PPO
To preview documents constructured by FluidDoc. Please follow the regular preview step, but replace the path to paddle with the path to FluidDoc
`./runserver --paddle <path_to_FluidDoc_dir>`
# Publish New release # Publish New release
1. Checkout a new release branch. The branch name should follow `release/<version>` 1. Checkout a new release branch. The branch name should follow `release/<version>`
1. Update the documentations on the submodules or within FluidDoc 1. Update the documentations on the submodules or within FluidDoc
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册