DOC: use mock for rtd (pysal#117)

* make readthedocs lightweight

* import momepy

* mock

* mock osgeo?

* try osgeo

* matplotlib

* exclude from codecov

* comment

* clean

.coveragerc

@@ -7,6 +7,8 @@ exclude_lines =
     pragma: no cover
     raise NotImplementedError
     if __name__ == .__main__.:
+    except ModuleNotFoundError:
+    print("rtd")
 ignore_errors = True
 omit =
     tests/*

docs/conf.py

@@ -16,10 +16,27 @@
 import sys
 import sphinx_bootstrap_theme
 
-import momepy
-
-# sys.path.insert(0, os.path.abspath('../../'))
-
+sys.path.insert(0, os.path.abspath("../.."))
+
+import momepy  # noqa
+
+autodoc_mock_imports = [
+    "geopandas",
+    "networkx",
+    "numpy",
+    "pandas",
+    "rtree",
+    "scipy",
+    "scipy.spatial" "shapely",
+    "shapely.geometry",
+    "shapely.wkt",
+    "shapely.ops",
+    "libpysal",
+    "tqdm",
+    "mapclassify",
+    "osmnx",
+    "inequality",
+]
 
 # -- Project information -----------------------------------------------------
 

docs/environment.yml

@@ -4,17 +4,8 @@ channels:
 dependencies:
     - sphinx_bootstrap_theme=0.6.4
     - python=3.7
-    - geopandas
-    - libpysal
-    - networkx
-    - tqdm
-    - mapclassify
-    - momepy
-    - matplotlib
-    - rtree
-    - osmnx
     - pip
+    - matplotlib
     - pip:
-        - inequality
         - sphinxcontrib.bibtex
         - numpydoc

momepy/elements.py

@@ -14,7 +14,12 @@
 from shapely.geometry import MultiPolygon, Point, Polygon
 from shapely.wkt import loads
 from tqdm import tqdm
-from osgeo import ogr
+
+# nothing - temporary solution for readthedocs fail. - cannot mock osgeo
+try:
+    from osgeo import ogr
+except ModuleNotFoundError:
+    print("rtd")
 
 __all__ = ["buffered_limit", "Tessellation", "Blocks", "get_network_id", "get_node_id"]
 

setup.cfg

@@ -5,3 +5,7 @@ versionfile_source = momepy/_version.py
 versionfile_build = momepy/_version.py
 tag_prefix = v
 parentdir_prefix = momepy-
+
+[flake8]
+# Black enforces 88 characters line length
+max_line_length = 88