Hot fix dygraph doc (PaddlePaddle#979)

Create a special case for dygraph-node when running gen_doc.
zhhsplendid · Jul 2, 2019 · 29670b4 · 29670b4
1 parent 35de048
commit 29670b4
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 27 deletions.
diff --git a/doc/fluid/api/dygraph.rst b/doc/fluid/api/dygraph.rst
@@ -12,7 +12,6 @@ BackwardStrategy
 
 ..  autoclass:: paddle.fluid.dygraph.BackwardStrategy
     :members:
-    :inherited-members:
     :noindex:
 
 .. _api_fluid_dygraph_BatchNorm:
@@ -22,7 +21,6 @@ BatchNorm
 
 ..  autoclass:: paddle.fluid.dygraph.BatchNorm
     :members:
-    :inherited-members:
     :noindex:
 
 .. _api_fluid_dygraph_BilinearTensorProduct:
@@ -32,7 +30,6 @@ BilinearTensorProduct
 
 ..  autoclass:: paddle.fluid.dygraph.BilinearTensorProduct
     :members:
-    :inherited-members:
     :noindex:
 
 .. _api_fluid_dygraph_Conv2D:
@@ -42,7 +39,6 @@ Conv2D
 
 ..  autoclass:: paddle.fluid.dygraph.Conv2D
     :members:
-    :inherited-members:
     :noindex:
 
 .. _api_fluid_dygraph_Conv2DTranspose:
@@ -52,7 +48,6 @@ Conv2DTranspose
 
 ..  autoclass:: paddle.fluid.dygraph.Conv2DTranspose
     :members:
-    :inherited-members:
     :noindex:
 
 .. _api_fluid_dygraph_Conv3D:
@@ -62,7 +57,6 @@ Conv3D
 
 ..  autoclass:: paddle.fluid.dygraph.Conv3D
     :members:
-    :inherited-members:
     :noindex:
 
 .. _api_fluid_dygraph_Conv3DTranspose:
@@ -72,7 +66,6 @@ Conv3DTranspose
 
 ..  autoclass:: paddle.fluid.dygraph.Conv3DTranspose
     :members:
-    :inherited-members:
     :noindex:
 
 .. _api_fluid_dygraph_CosineDecay:
@@ -82,7 +75,6 @@ CosineDecay
 
 ..  autoclass:: paddle.fluid.dygraph.CosineDecay
     :members:
-    :inherited-members:
     :noindex:
 
 .. _api_fluid_dygraph_Embedding:
@@ -92,7 +84,6 @@ Embedding
 
 ..  autoclass:: paddle.fluid.dygraph.Embedding
     :members:
-    :inherited-members:
     :noindex:
 
 .. _api_fluid_dygraph_enabled:
@@ -110,7 +101,6 @@ ExponentialDecay
 
 ..  autoclass:: paddle.fluid.dygraph.ExponentialDecay
     :members:
-    :inherited-members:
     :noindex:
 
 .. _api_fluid_dygraph_FC:
@@ -120,7 +110,6 @@ FC
 
 ..  autoclass:: paddle.fluid.dygraph.FC
     :members:
-    :inherited-members:
     :noindex:
 
 .. _api_fluid_dygraph_GroupNorm:
@@ -130,7 +119,6 @@ GroupNorm
 
 ..  autoclass:: paddle.fluid.dygraph.GroupNorm
     :members:
-    :inherited-members:
     :noindex:
 
 .. _api_fluid_dygraph_GRUUnit:
@@ -140,7 +128,6 @@ GRUUnit
 
 ..  autoclass:: paddle.fluid.dygraph.GRUUnit
     :members:
-    :inherited-members:
     :noindex:
 
 .. _api_fluid_dygraph_guard:
@@ -158,7 +145,6 @@ InverseTimeDecay
 
 ..  autoclass:: paddle.fluid.dygraph.InverseTimeDecay
     :members:
-    :inherited-members:
     :noindex:
 
 .. _api_fluid_dygraph_Layer:
@@ -168,7 +154,6 @@ Layer
 
 ..  autoclass:: paddle.fluid.dygraph.Layer
     :members:
-    :inherited-members:
     :noindex:
 
 .. _api_fluid_dygraph_LayerNorm:
@@ -178,7 +163,6 @@ LayerNorm
 
 ..  autoclass:: paddle.fluid.dygraph.LayerNorm
     :members:
-    :inherited-members:
     :noindex:
 
 .. _api_fluid_dygraph_load_persistables:
@@ -196,7 +180,6 @@ NaturalExpDecay
 
 ..  autoclass:: paddle.fluid.dygraph.NaturalExpDecay
     :members:
-    :inherited-members:
     :noindex:
 
 .. _api_fluid_dygraph_NCE:
@@ -206,7 +189,6 @@ NCE
 
 ..  autoclass:: paddle.fluid.dygraph.NCE
     :members:
-    :inherited-members:
     :noindex:
 
 .. _api_fluid_dygraph_no_grad:
@@ -224,7 +206,6 @@ NoamDecay
 
 ..  autoclass:: paddle.fluid.dygraph.NoamDecay
     :members:
-    :inherited-members:
     :noindex:
 
 .. _api_fluid_dygraph_not_support:
@@ -242,7 +223,6 @@ PiecewiseDecay
 
 ..  autoclass:: paddle.fluid.dygraph.PiecewiseDecay
     :members:
-    :inherited-members:
     :noindex:
 
 .. _api_fluid_dygraph_PolynomialDecay:
@@ -252,7 +232,6 @@ PolynomialDecay
 
 ..  autoclass:: paddle.fluid.dygraph.PolynomialDecay
     :members:
-    :inherited-members:
     :noindex:
 
 .. _api_fluid_dygraph_Pool2D:
@@ -262,7 +241,6 @@ Pool2D
 
 ..  autoclass:: paddle.fluid.dygraph.Pool2D
     :members:
-    :inherited-members:
     :noindex:
 
 .. _api_fluid_dygraph_PRelu:
@@ -272,7 +250,6 @@ PRelu
 
 ..  autoclass:: paddle.fluid.dygraph.PRelu
     :members:
-    :inherited-members:
     :noindex:
 
 .. _api_fluid_dygraph_prepare_context:
@@ -298,7 +275,6 @@ SpectralNorm
 
 ..  autoclass:: paddle.fluid.dygraph.SpectralNorm
     :members:
-    :inherited-members:
     :noindex:
 
 .. _api_fluid_dygraph_start_gperf_profiler:
@@ -332,7 +308,6 @@ Tracer
 
 ..  autoclass:: paddle.fluid.dygraph.Tracer
     :members:
-    :inherited-members:
     :noindex:
 
 .. _api_fluid_dygraph_TreeConv:
@@ -342,6 +317,5 @@ TreeConv
 
 ..  autoclass:: paddle.fluid.dygraph.TreeConv
     :members:
-    :inherited-members:
     :noindex:
 
diff --git a/doc/fluid/api/gen_doc.py b/doc/fluid/api/gen_doc.py
@@ -89,7 +89,14 @@ def print_item(self, name):
     def print_class(self, name):
         self._print_ref_(name)
         self._print_header_(name, dot='-', is_title=False)
-        self.stream.write('''..  autoclass:: paddle.{0}.{1}
+        if "fluid.dygraph" in self.module_prefix:
+            self.stream.write('''..  autoclass:: paddle.{0}.{1}
+    :members:
+    :noindex:
+
+'''.format(self.module_prefix, name))
+        else:
+            self.stream.write('''..  autoclass:: paddle.{0}.{1}
     :members:
     :inherited-members:
     :noindex: