PaddlePaddle · banma12956 · Jul 8, 2019 · Jul 8, 2019
diff --git a/docs/_static/build_toc_group.js b/docs/_static/build_toc_group.js
@@ -0,0 +1,65 @@
+// modified from
+// https://github.com/tensorpack/tensorpack/blob/master/docs/_static/build_toc_group.js
+
+$(function (){
+  var createList = function(selected) {
+    var obj = {};
+    var ul = $('<ul>');
+
+    selected.each(function(i,e) {
+
+      var groupName = $(e).find('a')[0].href;
+      groupName = groupName.substr(groupName.lastIndexOf('/')+1);
+      groupName = groupName.substr(0,groupName.lastIndexOf(".html")); 
+
+
+      var fullname = e.id;
+      if (fullname.startsWith('parl.'))
+        fullname = fullname.substr(5);
+
+      if (fullname == "dataflow.MultiProcessMapData") {
+        groupName = "parallel_map";
+      }
+
+      var n = $(e).children('.descname').clone();
+      n[0].innerText = fullname;
+
+      var l = $(e).children('.headerlink');
+      var a = $('<a>');
+      a.attr('href', l.attr('href')).attr('title', 'Link to this definition');
+      a.append(n);
+
+      var entry = $('<li>').append(a);
+
+      if(groupName in obj) {
+        obj[groupName].append(entry);
+      } else {
+        var ul = $('<ul style="margin-bottom: 12px;">');
+        ul.append(entry);
+        obj[groupName] = ul;
+      }
+    });
+
+    return obj;
+  }
+
+
+
+  var customIndex = $('.custom-index');
+  customIndex.empty();
+
+
+  var selected = $('div.section>dl>dt');
+  if (selected.length === 0)
+    return;
+
+  var obj = createList(selected);
+  var block = $('<div style="min-width: 300px; margin-bottom: 2em;">');
+  for(var key in obj) {
+    var a = $('<h6 style="margin-bottom: 0;">');
+    a.html(key + ':');
+    block.append(a);
+    block.append(obj[key]);
+  }
+  customIndex.append(block);
+});
diff --git a/docs/_templates/layout.html b/docs/_templates/layout.html
@@ -0,0 +1,20 @@
+{% extends "!layout.html" %}
+
+{%- block extrahead %}
+    <script type="text/javascript"
+						src={{ pathto('_static/jquery-3.2.1.min.js', 1) }}>
+		</script>
+    <script type="text/javascript"
+						src={{ pathto('_static/sanitize_desc_name.js', 1) }}>
+		</script>
+
+		<script>
+  (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+  (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+  m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+  })(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
+
+  ga('create', 'UA-42349716-2', 'auto');
+  ga('send', 'pageview');
+		</script>
+{% endblock %}
diff --git a/docs/algo_docs/a3c.rst b/docs/algo_docs/a3c.rst
@@ -0,0 +1,14 @@
+Algorithms.a3c
+--------------------
+
+.. container:: custom-index
+
+    .. raw:: html
+
+        <script type="text/javascript" src='../_static/build_toc_group.js'></script>
+
+
+.. automodule:: parl.algorithms.a3c
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/algo_docs/ddpg.rst b/docs/algo_docs/ddpg.rst
@@ -0,0 +1,14 @@
+Algorithms.ddpg
+--------------------
+
+.. container:: custom-index
+
+    .. raw:: html
+
+        <script type="text/javascript" src='../_static/build_toc_group.js'></script>
+
+
+.. automodule:: parl.algorithms.ddpg
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/algo_docs/dqn.rst b/docs/algo_docs/dqn.rst
@@ -0,0 +1,14 @@
+Algorithms.dqn
+--------------------
+
+.. container:: custom-index
+
+    .. raw:: html
+
+        <script type="text/javascript" src='../_static/build_toc_group.js'></script>
+
+
+.. automodule:: parl.algorithms.dqn
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/algo_docs/impala/impala.rst b/docs/algo_docs/impala/impala.rst
@@ -0,0 +1,14 @@
+Algorithms.impala
+--------------------
+
+.. container:: custom-index
+
+    .. raw:: html
+
+        <script type="text/javascript" src='../_static/build_toc_group.js'></script>
+
+
+.. automodule:: parl.algorithms.impala.impala
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/algo_docs/impala/index.rst b/docs/algo_docs/impala/index.rst
@@ -0,0 +1,9 @@
+Algorithms.impala
+=====================================
+
+.. toctree::
+  :maxdepth: 1
+
+  impala
+  vtrace
+
diff --git a/docs/algo_docs/impala/vtrace.rst b/docs/algo_docs/impala/vtrace.rst
@@ -0,0 +1,14 @@
+Algorithms.vtrace
+--------------------
+
+.. container:: custom-index
+
+    .. raw:: html
+
+        <script type="text/javascript" src='../_static/build_toc_group.js'></script>
+
+
+.. automodule:: parl.algorithms.impala.vtrace
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/algo_docs/index.rst b/docs/algo_docs/index.rst
@@ -0,0 +1,13 @@
+PARL.Algorithms
+=====================================
+
+.. toctree::
+  :maxdepth: 2
+
+  impala/index
+  a3c
+  ddpg
+  dqn
+  policy_gradient
+  ppo
+
diff --git a/docs/algo_docs/policy_gradient.rst b/docs/algo_docs/policy_gradient.rst
@@ -0,0 +1,14 @@
+Algorithms.policy_gradient
+----------------------------
+
+.. container:: custom-index
+
+    .. raw:: html
+
+        <script type="text/javascript" src='../_static/build_toc_group.js'></script>
+
+
+.. automodule:: parl.algorithms.policy_gradient
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/algo_docs/ppo.rst b/docs/algo_docs/ppo.rst
@@ -0,0 +1,14 @@
+Algorithms.ppo
+--------------------
+
+.. container:: custom-index
+
+    .. raw:: html
+
+        <script type="text/javascript" src='../_static/build_toc_group.js'></script>
+
+
+.. automodule:: parl.algorithms.ppo
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/api_docs/index.rst b/docs/api_docs/index.rst
diff --git a/docs/api_docs/utils.rst b/docs/api_docs/utils.rst
diff --git a/docs/conf.py b/docs/conf.py
@@ -34,6 +34,7 @@
 import os
 import sys
 import parl
+autodoc_mock_imports = ['paddle']
 release = parl.__version__
 project = 'PARL'
 copyright = '2019, nlp-ol@baidu.com'

diff --git a/docs/framework_docs/agent_base.rst b/docs/framework_docs/agent_base.rst
@@ -0,0 +1,14 @@
+Framework.agent_base
+--------------------
+
+.. container:: custom-index
+
+    .. raw:: html
+
+        <script type="text/javascript" src='../_static/build_toc_group.js'></script>
+
+
+.. automodule:: parl.framework.agent_base
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/framework_docs/algorithm_base.rst b/docs/framework_docs/algorithm_base.rst
@@ -0,0 +1,14 @@
+Framework.algorithm_base
+---------------------------
+
+.. container:: custom-index
+
+    .. raw:: html
+
+        <script type="text/javascript" src='../_static/build_toc_group.js'></script>
+
+
+.. automodule:: parl.framework.algorithm_base
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/framework_docs/index.rst b/docs/framework_docs/index.rst
@@ -0,0 +1,10 @@
+PARL.Framework
+=====================================
+
+.. toctree::
+  :maxdepth: 1
+
+  agent_base
+  algorithm_base
+  model_base
+  policy_distri
diff --git a/docs/framework_docs/model_base.rst b/docs/framework_docs/model_base.rst
@@ -0,0 +1,14 @@
+Framework.model_base
+--------------------
+
+.. container:: custom-index
+
+    .. raw:: html
+
+        <script type="text/javascript" src='../_static/build_toc_group.js'></script>
+
+
+.. automodule:: parl.framework.model_base
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/framework_docs/policy_distri.rst b/docs/framework_docs/policy_distri.rst
@@ -0,0 +1,14 @@
+Framework.policy_distribution
+--------------------
+
+.. container:: custom-index
+
+    .. raw:: html
+
+        <script type="text/javascript" src='../_static/build_toc_group.js'></script>
+
+
+.. automodule:: parl.framework.policy_distribution
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/index.rst b/docs/index.rst
@@ -68,11 +68,15 @@ Features
    implementations.rst
 
 .. toctree::
-   :maxdepth: 1
-   :caption: APIs
-
-   ./api_docs.utils
-   ./api_docs.index
+   :maxdepth: 3
+   :caption: API
+
+   algo_docs/index
+   framework_docs/index
+   layers_docs/index
+   plutils_docs/index
+   remote_docs/index
+   utils_docs/index
 
 Abstractions
 ----------------

diff --git a/docs/installation.rst b/docs/installation.rst
@@ -9,4 +9,4 @@ Install
 -------------
 PARL is distributed on PyPI and can be installed with pip:
 :: 
-    pip install parl
+   pip install parl
diff --git a/docs/layers_docs/attr_holder.rst b/docs/layers_docs/attr_holder.rst
@@ -0,0 +1,14 @@
+Layers.attr_docs
+--------------------
+
+.. container:: custom-index
+
+    .. raw:: html
+
+        <script type="text/javascript" src='../_static/build_toc_group.js'></script>
+
+
+.. automodule:: parl.layers.attr_holder
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/layers_docs/index.rst b/docs/layers_docs/index.rst
@@ -0,0 +1,9 @@
+PARL.Layers
+=====================================
+
+.. toctree::
+  :maxdepth: 1
+
+  attr_holder
+  layer_wrappers
+
diff --git a/docs/layers_docs/layer_wrappers.rst b/docs/layers_docs/layer_wrappers.rst
@@ -0,0 +1,14 @@
+Layers.layer_wrappers
+--------------------
+
+.. container:: custom-index
+
+    .. raw:: html
+
+        <script type="text/javascript" src='../_static/build_toc_group.js'></script>
+
+
+.. automodule:: parl.layers.layer_wrappers
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/plutils_docs/common.rst b/docs/plutils_docs/common.rst
@@ -0,0 +1,14 @@
+Plutils.common
+--------------------
+
+.. container:: custom-index
+
+    .. raw:: html
+
+        <script type="text/javascript" src='../_static/build_toc_group.js'></script>
+
+
+.. automodule:: parl.plutils.common
+    :members:
+    :undoc-members:
+    :show-inheritance: