Ensure autodoc is able to import pymongoarrow.api when building on ReadTheDocs (#25)

Author: prashantmital

bindings/python/docs/source/conf.py

@@ -10,9 +10,9 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
-# import os
-# import sys
-# sys.path.insert(0, os.path.abspath('.'))
+import os
+import sys
+sys.path.insert(0, os.path.abspath('../..'))
 
 
 # -- Project information -----------------------------------------------------
@@ -36,6 +36,11 @@
     'sphinx.ext.intersphinx'
 ]
 
+# https://docs.readthedocs.io/en/stable/faq.html#i-get-import-errors-on-libraries-that-depend-on-c-modules
+autodoc_mock_imports = ['pyarrow',
+                        'pymongoarrow.lib',
+                        'bson']
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 

bindings/python/pymongoarrow/__init__.py

@@ -11,7 +11,7 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.
-
+import os
 # We must import pyarrow before attempting to load the Cython module.
 import pyarrow
 
@@ -27,8 +27,10 @@
     def _parse_version(version):
         return _LooseVersion(version)
 
-
-if _parse_version(libbson_version) < _parse_version(_MIN_LIBBSON_VERSION):
-    raise ImportError(
-        f"Expected libbson version {_MIN_LIBBSON_VERSION} or greater, "
-        f"found {libbson_version}")
+# TODO: PYTHON-2659
+on_rtd = os.environ.get('READTHEDOCS') == 'True'
+if not on_rtd:
+    if _parse_version(libbson_version) < _parse_version(_MIN_LIBBSON_VERSION):
+        raise ImportError(
+            f"Expected libbson version {_MIN_LIBBSON_VERSION} or greater, "
+            f"found {libbson_version}")