Skip to content

Commit 29670b4

Browse files
authored
Hot fix dygraph doc (PaddlePaddle#979)
Create a special case for dygraph-node when running gen_doc.
1 parent 35de048 commit 29670b4

File tree

2 files changed

+8
-27
lines changed

2 files changed

+8
-27
lines changed

doc/fluid/api/dygraph.rst

Lines changed: 0 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ BackwardStrategy
1212

1313
.. autoclass:: paddle.fluid.dygraph.BackwardStrategy
1414
:members:
15-
:inherited-members:
1615
:noindex:
1716

1817
.. _api_fluid_dygraph_BatchNorm:
@@ -22,7 +21,6 @@ BatchNorm
2221

2322
.. autoclass:: paddle.fluid.dygraph.BatchNorm
2423
:members:
25-
:inherited-members:
2624
:noindex:
2725

2826
.. _api_fluid_dygraph_BilinearTensorProduct:
@@ -32,7 +30,6 @@ BilinearTensorProduct
3230

3331
.. autoclass:: paddle.fluid.dygraph.BilinearTensorProduct
3432
:members:
35-
:inherited-members:
3633
:noindex:
3734

3835
.. _api_fluid_dygraph_Conv2D:
@@ -42,7 +39,6 @@ Conv2D
4239

4340
.. autoclass:: paddle.fluid.dygraph.Conv2D
4441
:members:
45-
:inherited-members:
4642
:noindex:
4743

4844
.. _api_fluid_dygraph_Conv2DTranspose:
@@ -52,7 +48,6 @@ Conv2DTranspose
5248

5349
.. autoclass:: paddle.fluid.dygraph.Conv2DTranspose
5450
:members:
55-
:inherited-members:
5651
:noindex:
5752

5853
.. _api_fluid_dygraph_Conv3D:
@@ -62,7 +57,6 @@ Conv3D
6257

6358
.. autoclass:: paddle.fluid.dygraph.Conv3D
6459
:members:
65-
:inherited-members:
6660
:noindex:
6761

6862
.. _api_fluid_dygraph_Conv3DTranspose:
@@ -72,7 +66,6 @@ Conv3DTranspose
7266

7367
.. autoclass:: paddle.fluid.dygraph.Conv3DTranspose
7468
:members:
75-
:inherited-members:
7669
:noindex:
7770

7871
.. _api_fluid_dygraph_CosineDecay:
@@ -82,7 +75,6 @@ CosineDecay
8275

8376
.. autoclass:: paddle.fluid.dygraph.CosineDecay
8477
:members:
85-
:inherited-members:
8678
:noindex:
8779

8880
.. _api_fluid_dygraph_Embedding:
@@ -92,7 +84,6 @@ Embedding
9284

9385
.. autoclass:: paddle.fluid.dygraph.Embedding
9486
:members:
95-
:inherited-members:
9687
:noindex:
9788

9889
.. _api_fluid_dygraph_enabled:
@@ -110,7 +101,6 @@ ExponentialDecay
110101

111102
.. autoclass:: paddle.fluid.dygraph.ExponentialDecay
112103
:members:
113-
:inherited-members:
114104
:noindex:
115105

116106
.. _api_fluid_dygraph_FC:
@@ -120,7 +110,6 @@ FC
120110

121111
.. autoclass:: paddle.fluid.dygraph.FC
122112
:members:
123-
:inherited-members:
124113
:noindex:
125114

126115
.. _api_fluid_dygraph_GroupNorm:
@@ -130,7 +119,6 @@ GroupNorm
130119

131120
.. autoclass:: paddle.fluid.dygraph.GroupNorm
132121
:members:
133-
:inherited-members:
134122
:noindex:
135123

136124
.. _api_fluid_dygraph_GRUUnit:
@@ -140,7 +128,6 @@ GRUUnit
140128

141129
.. autoclass:: paddle.fluid.dygraph.GRUUnit
142130
:members:
143-
:inherited-members:
144131
:noindex:
145132

146133
.. _api_fluid_dygraph_guard:
@@ -158,7 +145,6 @@ InverseTimeDecay
158145

159146
.. autoclass:: paddle.fluid.dygraph.InverseTimeDecay
160147
:members:
161-
:inherited-members:
162148
:noindex:
163149

164150
.. _api_fluid_dygraph_Layer:
@@ -168,7 +154,6 @@ Layer
168154

169155
.. autoclass:: paddle.fluid.dygraph.Layer
170156
:members:
171-
:inherited-members:
172157
:noindex:
173158

174159
.. _api_fluid_dygraph_LayerNorm:
@@ -178,7 +163,6 @@ LayerNorm
178163

179164
.. autoclass:: paddle.fluid.dygraph.LayerNorm
180165
:members:
181-
:inherited-members:
182166
:noindex:
183167

184168
.. _api_fluid_dygraph_load_persistables:
@@ -196,7 +180,6 @@ NaturalExpDecay
196180

197181
.. autoclass:: paddle.fluid.dygraph.NaturalExpDecay
198182
:members:
199-
:inherited-members:
200183
:noindex:
201184

202185
.. _api_fluid_dygraph_NCE:
@@ -206,7 +189,6 @@ NCE
206189

207190
.. autoclass:: paddle.fluid.dygraph.NCE
208191
:members:
209-
:inherited-members:
210192
:noindex:
211193

212194
.. _api_fluid_dygraph_no_grad:
@@ -224,7 +206,6 @@ NoamDecay
224206

225207
.. autoclass:: paddle.fluid.dygraph.NoamDecay
226208
:members:
227-
:inherited-members:
228209
:noindex:
229210

230211
.. _api_fluid_dygraph_not_support:
@@ -242,7 +223,6 @@ PiecewiseDecay
242223

243224
.. autoclass:: paddle.fluid.dygraph.PiecewiseDecay
244225
:members:
245-
:inherited-members:
246226
:noindex:
247227

248228
.. _api_fluid_dygraph_PolynomialDecay:
@@ -252,7 +232,6 @@ PolynomialDecay
252232

253233
.. autoclass:: paddle.fluid.dygraph.PolynomialDecay
254234
:members:
255-
:inherited-members:
256235
:noindex:
257236

258237
.. _api_fluid_dygraph_Pool2D:
@@ -262,7 +241,6 @@ Pool2D
262241

263242
.. autoclass:: paddle.fluid.dygraph.Pool2D
264243
:members:
265-
:inherited-members:
266244
:noindex:
267245

268246
.. _api_fluid_dygraph_PRelu:
@@ -272,7 +250,6 @@ PRelu
272250

273251
.. autoclass:: paddle.fluid.dygraph.PRelu
274252
:members:
275-
:inherited-members:
276253
:noindex:
277254

278255
.. _api_fluid_dygraph_prepare_context:
@@ -298,7 +275,6 @@ SpectralNorm
298275

299276
.. autoclass:: paddle.fluid.dygraph.SpectralNorm
300277
:members:
301-
:inherited-members:
302278
:noindex:
303279

304280
.. _api_fluid_dygraph_start_gperf_profiler:
@@ -332,7 +308,6 @@ Tracer
332308

333309
.. autoclass:: paddle.fluid.dygraph.Tracer
334310
:members:
335-
:inherited-members:
336311
:noindex:
337312

338313
.. _api_fluid_dygraph_TreeConv:
@@ -342,6 +317,5 @@ TreeConv
342317

343318
.. autoclass:: paddle.fluid.dygraph.TreeConv
344319
:members:
345-
:inherited-members:
346320
:noindex:
347321

doc/fluid/api/gen_doc.py

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,14 @@ def print_item(self, name):
8989
def print_class(self, name):
9090
self._print_ref_(name)
9191
self._print_header_(name, dot='-', is_title=False)
92-
self.stream.write('''.. autoclass:: paddle.{0}.{1}
92+
if "fluid.dygraph" in self.module_prefix:
93+
self.stream.write('''.. autoclass:: paddle.{0}.{1}
94+
:members:
95+
:noindex:
96+
97+
'''.format(self.module_prefix, name))
98+
else:
99+
self.stream.write('''.. autoclass:: paddle.{0}.{1}
93100
:members:
94101
:inherited-members:
95102
:noindex:

0 commit comments

Comments
 (0)