]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc: build api docs with Read the Docs 38431/head
authorKefu Chai <kchai@redhat.com>
Thu, 3 Dec 2020 10:18:17 +0000 (18:18 +0800)
committerKefu Chai <kchai@redhat.com>
Sat, 5 Dec 2020 14:09:22 +0000 (22:09 +0800)
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 <kchai@redhat.com>
admin/doc-read-the-docs.txt
doc/conf.py

index b65cc4638491a583db59c7aeb0d5f8c3cfbfbee1..c66a08d9a8785423f6379bdd683bbf1b15e41eda 100644 (file)
@@ -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
index 8565abde46b7d89fceb0aeeffc0f299ab6c87b03..cbc05b1ba16fce654e05d9b04c027e2eff753159 100644 (file)
@@ -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: