Skip to content

Generate docs for Fluid API #6215

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 3 commits into from
Dec 4, 2017
Merged

Generate docs for Fluid API #6215

merged 3 commits into from
Dec 4, 2017

Conversation

@QiJune
Copy link
Member

@QiJune QiJune commented Dec 4, 2017 •
edited
Loading

Fix #6214

luotao1
luotao1 reviewed Dec 4, 2017
View reviewed changes
Copy link
Contributor

@luotao1 luotao1 left a comment •
edited
Loading

Choose a reason for hiding this comment

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

After this PR, we can remove operators.html since many of them are duplicated.

doc/api/v2/fluid.rst
fluid/optimizer.rst
fluid/param_attr.rst
fluid/profiler.rst
fluid/regularizer.rst
Copy link
Contributor

Choose a reason for hiding this comment

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

We should adjust the order in next PRs

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes, I think we can merge this PR first. And then more developers can join in and we can make iterative document polishing.

doc/api/v2/fluid/data_feeder.rst
===========
DataFeeder
===========

Copy link
Contributor

Choose a reason for hiding this comment

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

There are a lot of blank lines in rst.
You can delete these, for example, line 5-6.

Copy link
Member Author

Choose a reason for hiding this comment

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

Done

doc/api/v2/fluid/initializer.rst Outdated


ConstantInitializer
-----------
Copy link
Contributor

Choose a reason for hiding this comment

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

line 16 should be longer than line 15, otherwise, there will be warnings when compile paddle_docs

Copy link
Member Author

Choose a reason for hiding this comment

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

Done

luotao1
luotao1 approved these changes Dec 4, 2017
View reviewed changes
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

@QiJune QiJune merged commit 1fe05c4 into PaddlePaddle:develop Dec 4, 2017
abhinavarora
abhinavarora reviewed Dec 4, 2017
View reviewed changes
Copy link
Contributor

@abhinavarora abhinavarora left a comment

Choose a reason for hiding this comment

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

LGTM!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@luotao1 luotao1 luotao1 approved these changes

@reyoung reyoung Awaiting requested review from reyoung

+1 more reviewer

@abhinavarora abhinavarora abhinavarora left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@QiJune @abhinavarora @luotao1