From 670efdd3c7275251bc37773146d53f4979e442df Mon Sep 17 00:00:00 2001 From: Kefu Chai Date: Thu, 3 Dec 2020 18:18:17 +0800 Subject: [PATCH] doc: build api docs with Read the Docs since we are able to build the python bindings using the stub implementation of C binding, let's enable the API docs build. Signed-off-by: Kefu Chai --- admin/doc-read-the-docs.txt | 5 +++++ doc/conf.py | 9 +-------- 2 files changed, 6 insertions(+), 8 deletions(-) diff --git a/admin/doc-read-the-docs.txt b/admin/doc-read-the-docs.txt index b65cc4638491a..c66a08d9a8785 100644 --- a/admin/doc-read-the-docs.txt +++ b/admin/doc-read-the-docs.txt @@ -1,2 +1,7 @@ plantweb git+https://github.com/readthedocs/readthedocs-sphinx-search@master +Cython +src/pybind/rados +src/pybind/cephfs +src/pybind/rbd +src/pybind/rgw diff --git a/doc/conf.py b/doc/conf.py index 8565abde46b7d..cbc05b1ba16fc 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -91,10 +91,6 @@ else: build_with_rtd = os.environ.get('READTHEDOCS') == 'True' -if build_with_rtd: - exclude_patterns += ['**/api/*', - '**/api.rst'] - sys.path.insert(0, os.path.abspath('_ext')) extensions = [ @@ -203,10 +199,7 @@ class Mock(object): sys.modules['ceph_module'] = Mock() if build_with_rtd: - autodoc_mock_imports = ['cephfs', - 'rados', - 'rbd', - 'ceph'] + autodoc_mock_imports = ['ceph'] pybinds = ['pybind/mgr', 'python-common'] else: -- 2.39.5