Skip to content

add independent sphinx tree for api #8145

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

Merged
merged 1 commit into from
Feb 5, 2018
Merged

add independent sphinx tree for api #8145

merged 1 commit into from
Feb 5, 2018

Conversation

luotao1
Copy link
Contributor

@luotao1 luotao1 commented Feb 5, 2018

fix #8128
The entry for this independent sphinx tree is : ${DIR}/api_doc

@luotao1 luotao1 requested review from Xreki and shanyi15 February 5, 2018 10:58
@luotao1
Copy link
Contributor Author

luotao1 commented Feb 5, 2018

The temporary effect likes:
image

Copy link
Collaborator

@shanyi15 shanyi15 left a comment

Choose a reason for hiding this comment

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

LGTM for the website effect, @Xreki please double check the code

set -e
cp -r ../doc/cn/html ${DIR}/doc_cn
cp -r ../doc/en/html ${DIR}/doc
cp -r ../doc/api/en/html ${DIR}/api_doc
Copy link
Contributor

@Xreki Xreki Feb 5, 2018

Choose a reason for hiding this comment

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

我有几个疑问,已经跟@luotao1 线下确认过了:

  • API只生成英文版。网站中英文切换时,API由前端控制,始终显示英文版本。
  • API下面的内容由文档工程师后面统一修改。

Copy link
Contributor

@Xreki Xreki left a comment

Choose a reason for hiding this comment

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

LGTM

@luotao1 luotao1 merged commit 845058a into PaddlePaddle:develop Feb 5, 2018
@luotao1 luotao1 deleted the api_sphinx branch February 5, 2018 12:25
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.

Make the classification of API documentation suitable for API independent sphinx tree in enhanced paddlepaddle.org
3 participants