Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Build basic sphinx doctree for doc/fluid #9236

Merged
merged 2 commits into from
Mar 22, 2018

Conversation

weixing02
Copy link
Collaborator

@weixing02 weixing02 commented Mar 20, 2018

Since part of the directory structure of the fluid has already been determined, I constructed a sphinx doctree for it(Empty directory structure), but the contents of each directory are temporarily empty and need to be added later. Now the basic page looks like this
page

@weixing02 weixing02 requested a review from luotao1 March 20, 2018 08:05
@luotao1
Copy link
Contributor

luotao1 commented Mar 20, 2018

Copy link
Contributor

@luotao1 luotao1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@@ -0,0 +1,49 @@
if(NOT DEFINED SPHINX_THEME)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

可以在后续的PR中分批完成:

  1. 现在的命令是:paddle_fluid_docs, 那v2下的命令应该改为paddle_v2_docs等。
  2. 现在make paddle_docs前需要先make gen_proto_py,可以让paddle_docs依赖gen_proto_py,这样编译文档只需要使用make paddle_docs即可,比较清晰。其余命令类似。
  3. 编译文档现在有四个命令:v2/fluid+中英文,可以考虑再增加一个命令make paddle_docs编译出所有的文档。
  4. 目前doc/v2/CMakeLists.txt, doc/v2/api/CMakeLists.txt, doc/fluid/CMakeLists.txt 都非常类似,可以考虑使用function来包装一下。

@luotao1 luotao1 merged commit 259ef4a into PaddlePaddle:develop Mar 22, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants