From 3789dbcab4c0bc5c672a66ca408f520dfc1c2257 Mon Sep 17 00:00:00 2001 From: LI Yunxiang <1718613239banma@gmail.com> Date: Mon, 8 Jul 2019 18:06:57 +0800 Subject: [PATCH 1/2] add code autodoc --- docs/_static/build_toc_group.js | 65 ++++++++++++++++++++++++++ docs/_templates/layout.html | 20 ++++++++ docs/algo_docs/a3c.rst | 14 ++++++ docs/algo_docs/ddpg.rst | 14 ++++++ docs/algo_docs/dqn.rst | 14 ++++++ docs/algo_docs/impala/impala.rst | 14 ++++++ docs/algo_docs/impala/index.rst | 8 ++++ docs/algo_docs/impala/vtrace.rst | 14 ++++++ docs/algo_docs/index.rst | 12 +++++ docs/algo_docs/policy_gradient.rst | 14 ++++++ docs/algo_docs/ppo.rst | 14 ++++++ docs/api_docs/index.rst | 12 ----- docs/api_docs/utils.rst | 6 --- docs/conf.py | 3 ++ docs/framework_docs/agent_base.rst | 14 ++++++ docs/framework_docs/algorithm_base.rst | 14 ++++++ docs/framework_docs/index.rst | 10 ++++ docs/framework_docs/model_base.rst | 14 ++++++ docs/framework_docs/policy_distri.rst | 14 ++++++ docs/index.rst | 14 ++++-- docs/installation.rst | 2 +- docs/layers_docs/attr_holder.rst | 14 ++++++ docs/layers_docs/index.rst | 9 ++++ docs/layers_docs/layer_wrappers.rst | 14 ++++++ docs/plutils_docs/common.rst | 14 ++++++ docs/plutils_docs/index.rst | 8 ++++ docs/remote_docs/exceptions.rst | 14 ++++++ docs/remote_docs/index.rst | 12 +++++ docs/remote_docs/remote_constants.rst | 14 ++++++ docs/remote_docs/remote_decorator.rst | 14 ++++++ docs/remote_docs/remote_manager.rst | 14 ++++++ docs/remote_docs/remote_object.rst | 14 ++++++ docs/utils_docs/communication.rst | 14 ++++++ docs/utils_docs/csv_logger.rst | 14 ++++++ docs/utils_docs/exceptions.rst | 14 ++++++ docs/utils_docs/index.rst | 19 ++++++++ docs/utils_docs/logger.rst | 14 ++++++ docs/utils_docs/machine_info.rst | 14 ++++++ docs/utils_docs/np_utils.rst | 14 ++++++ docs/utils_docs/replay_memory.rst | 14 ++++++ docs/utils_docs/rl_utils.rst | 14 ++++++ docs/utils_docs/scheduler.rst | 14 ++++++ docs/utils_docs/time_stat.rst | 14 ++++++ docs/utils_docs/utils.rst | 14 ++++++ docs/utils_docs/window_stat.rst | 14 ++++++ 45 files changed, 610 insertions(+), 24 deletions(-) create mode 100644 docs/_static/build_toc_group.js create mode 100644 docs/_templates/layout.html create mode 100644 docs/algo_docs/a3c.rst create mode 100644 docs/algo_docs/ddpg.rst create mode 100644 docs/algo_docs/dqn.rst create mode 100644 docs/algo_docs/impala/impala.rst create mode 100644 docs/algo_docs/impala/index.rst create mode 100644 docs/algo_docs/impala/vtrace.rst create mode 100644 docs/algo_docs/index.rst create mode 100644 docs/algo_docs/policy_gradient.rst create mode 100644 docs/algo_docs/ppo.rst delete mode 100644 docs/api_docs/index.rst delete mode 100644 docs/api_docs/utils.rst create mode 100644 docs/framework_docs/agent_base.rst create mode 100644 docs/framework_docs/algorithm_base.rst create mode 100644 docs/framework_docs/index.rst create mode 100644 docs/framework_docs/model_base.rst create mode 100644 docs/framework_docs/policy_distri.rst create mode 100644 docs/layers_docs/attr_holder.rst create mode 100644 docs/layers_docs/index.rst create mode 100644 docs/layers_docs/layer_wrappers.rst create mode 100644 docs/plutils_docs/common.rst create mode 100644 docs/plutils_docs/index.rst create mode 100644 docs/remote_docs/exceptions.rst create mode 100644 docs/remote_docs/index.rst create mode 100644 docs/remote_docs/remote_constants.rst create mode 100644 docs/remote_docs/remote_decorator.rst create mode 100644 docs/remote_docs/remote_manager.rst create mode 100644 docs/remote_docs/remote_object.rst create mode 100644 docs/utils_docs/communication.rst create mode 100644 docs/utils_docs/csv_logger.rst create mode 100644 docs/utils_docs/exceptions.rst create mode 100644 docs/utils_docs/index.rst create mode 100644 docs/utils_docs/logger.rst create mode 100644 docs/utils_docs/machine_info.rst create mode 100644 docs/utils_docs/np_utils.rst create mode 100644 docs/utils_docs/replay_memory.rst create mode 100644 docs/utils_docs/rl_utils.rst create mode 100644 docs/utils_docs/scheduler.rst create mode 100644 docs/utils_docs/time_stat.rst create mode 100644 docs/utils_docs/utils.rst create mode 100644 docs/utils_docs/window_stat.rst diff --git a/docs/_static/build_toc_group.js b/docs/_static/build_toc_group.js new file mode 100644 index 000000000..a41bfb875 --- /dev/null +++ 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 = $('