Merge pull request #463 from luotao1/doc2

modify document directory structure in model config helpers
9 years ago · a0bd8952af
parent 35c175ddf9 e6396a1f26
commit a0bd8952af
15 changed files with 42 additions and 62 deletions
--- a/doc/index.md
+++ b/doc/index.md
@ -8,7 +8,7 @@ User Guide
 * [Build and Installation](build/index.rst)
 * [Contribute Code](build/contribute_to_paddle.md)
 * [User Interface](ui/index.md)
-* [Model Config Interface](ui/api/trainer_config_helpers/index.md)
+* [Model Config Interface](ui/api/trainer_config_helpers/index.rst)
 * [Example and Demo](demo/index.md)
 * [Cluster Train](cluster/index.md)

--- a/doc/ui/api/trainer_config_helpers/activations.rst
+++ b/doc/ui/api/trainer_config_helpers/activations.rst
@ -1,3 +1,7 @@
+===========
+Activations
+===========
+
 BaseActivation
 ==============

@ -102,4 +106,3 @@ STanhActivation
 ..  automodule:: paddle.trainer_config_helpers.activations
    :members: STanhActivation
    :noindex:
-    
--- a/doc/ui/api/trainer_config_helpers/activations_index.rst
+++ b/doc/ui/api/trainer_config_helpers/activations_index.rst
@ -1,7 +0,0 @@
-Activations
-===========
-
-.. toctree::
-  :maxdepth: 3
-
-  activations.rst
--- a/doc/ui/api/trainer_config_helpers/evaluators.rst
+++ b/doc/ui/api/trainer_config_helpers/evaluators.rst
@ -1,3 +1,7 @@
+==========
+Evaluators
+==========
+
 Base
 ====
 ..  automodule:: paddle.trainer_config_helpers.evaluators
--- a/doc/ui/api/trainer_config_helpers/evaluators_index.rst
+++ b/doc/ui/api/trainer_config_helpers/evaluators_index.rst
@ -1,7 +0,0 @@
-Evaluators
-==========
-
-.. toctree::
-  :maxdepth: 3
-
-  evaluators.rst
--- a/doc/ui/api/trainer_config_helpers/index.md
+++ b/doc/ui/api/trainer_config_helpers/index.md
@ -1,10 +0,0 @@
-# Model Config Interface
-
-* [Optimizer](optimizers_index.rst)
-* [Data Source](data_sources.rst)
-* [Layers](layers_index.rst)
-* [Activations](activations_index.rst)
-* [Poolings](poolings_index.rst)
-* [Networks](networks_index.rst)
-* [Evaluators](evaluators_index.rst)
-* [Parameter and Extra Layer Attribute](attrs.rst)
--- a/doc/ui/api/trainer_config_helpers/index.rst
+++ b/doc/ui/api/trainer_config_helpers/index.rst
@ -0,0 +1,14 @@
+Model Config Interface
+======================
+
+.. toctree::
+  :maxdepth: 1
+
+  optimizers.rst
+  data_sources.rst
+  layers.rst
+  activations.rst 
+  poolings.rst
+  networks.rst
+  evaluators.rst
+  attrs.rst
--- a/doc/ui/api/trainer_config_helpers/layers.rst
+++ b/doc/ui/api/trainer_config_helpers/layers.rst
@ -1,3 +1,7 @@
+======
+Layers
+======
+
 Base
 ======

@ -47,7 +51,7 @@ conv_operator
    :noindex:

 conv_projection
-------------
+---------------
 ..  automodule:: paddle.trainer_config_helpers.layers
    :members: conv_projection
    :noindex:
--- a/doc/ui/api/trainer_config_helpers/layers_index.rst
+++ b/doc/ui/api/trainer_config_helpers/layers_index.rst
@ -1,7 +0,0 @@
-Layers
-======
-
-.. toctree::
-  :maxdepth: 3
-
-  layers.rst
--- a/doc/ui/api/trainer_config_helpers/networks.rst
+++ b/doc/ui/api/trainer_config_helpers/networks.rst
@ -1,3 +1,9 @@
+========
+Networks
+========
+
+The networks module contains pieces of neural network that combine multiple layers.
+
 NLP
 ===

@ -111,4 +117,3 @@ outputs
 ..  automodule:: paddle.trainer_config_helpers.networks
    :members: outputs
    :noindex:
-
--- a/doc/ui/api/trainer_config_helpers/networks_index.rst
+++ b/doc/ui/api/trainer_config_helpers/networks_index.rst
@ -1,9 +0,0 @@
-Networks
-========
-
-The networks module contains pieces of neural network that combine multiple layers.
-
-.. toctree::
-  :maxdepth: 3
-
-  networks.rst
--- a/doc/ui/api/trainer_config_helpers/optimizers.rst
+++ b/doc/ui/api/trainer_config_helpers/optimizers.rst
@ -1,3 +1,7 @@
+==========
+Optimizers
+==========
+
 BaseSGDOptimizer
 ================
 ..  automodule:: paddle.trainer_config_helpers.optimizers
@ -51,4 +55,3 @@ settings
 ..  automodule:: paddle.trainer_config_helpers.optimizers
    :members: settings
    :noindex:
-
--- a/doc/ui/api/trainer_config_helpers/optimizers_index.rst
+++ b/doc/ui/api/trainer_config_helpers/optimizers_index.rst
@ -1,7 +0,0 @@
-Optimizers
-==========
-
-.. toctree::
-  :maxdepth: 3
-
-  optimizers.rst
--- a/doc/ui/api/trainer_config_helpers/poolings.rst
+++ b/doc/ui/api/trainer_config_helpers/poolings.rst
@ -1,3 +1,7 @@
+========
+Poolings
+========
+
 BasePoolingType
 ===============
 ..  automodule:: paddle.trainer_config_helpers.poolings
@ -27,4 +31,3 @@ SquareRootNPooling
 ..  automodule:: paddle.trainer_config_helpers.poolings
    :members: SquareRootNPooling
    :noindex:
-
--- a/doc/ui/api/trainer_config_helpers/poolings_index.rst
+++ b/doc/ui/api/trainer_config_helpers/poolings_index.rst
@ -1,9 +0,0 @@
-Poolings
-========
-
-These pooling types are used for sequence input, not for images.
-
-.. toctree::
-  :maxdepth: 3
-
-  poolings.rst