From 2f11d0c53d7eed7736f8ee8c90858ad5cf447b25 Mon Sep 17 00:00:00 2001 From: Bo Zhou <2466956298@qq.com> Date: Wed, 31 Jul 2019 14:25:41 +0800 Subject: [PATCH] fix the bug in building the the docs (#104) * fix the bug in building the the docs * update the version of the required Paddle --- docs/conf.py | 15 +-------------- docs/installation.rst | 2 +- 2 files changed, 2 insertions(+), 15 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 3153946..e4e009f 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -40,6 +40,7 @@ copyright = '2019, nlp-ol@baidu.com' author = 'nlp-ol@baidu.com' # The full version, including alpha/beta/rc tags +autodoc_mock_imports = ['paddle'] # -- General configuration --------------------------------------------------- @@ -95,22 +96,8 @@ def skip(app, what, name, obj, would_skip, options): return would_skip -aliases = dict() -aliases['parl.core.fluid.agent.Agent'] = ['parl.agent'] - - -def parl_class_docstring(app, what, name, obj, options, lines): - if what != 'class': - return - obj = parl.Agent - name = parl.Agent - - #lines[0] = ['wohenhao'] - - def setup(app): app.connect("autodoc-skip-member", skip) - app.connect("autodoc-process-docstring", parl_class_docstring) add_module_names = False diff --git a/docs/installation.rst b/docs/installation.rst index 8cad985..9685bb2 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -3,7 +3,7 @@ Installation Dependencies ------------------- - Python 2.7 or 3.5+. -- PaddlePaddle >=1.2.1 (**Optional**, if you only want to use APIs related to parallelization alone) +- PaddlePaddle >=1.5.1 (**Optional**, if you only want to use APIs related to parallelization alone) Install ------------- -- GitLab