Fixed html not found error opengeos#88

wnelso18 · Jul 28, 2021 · f690b7b · f690b7b
1 parent 5a9f250
commit f690b7b
Show file tree

Hide file tree

Showing 7 changed files with 28 additions and 22 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -30,5 +30,6 @@ jobs:
             - run: mkdocs gh-deploy --force
               env:
                   USE_FOLIUM: ${{ secrets.USE_FOLIUM }}
+                  USE_MKDOCS: ${{ secrets.USE_MKDOCS }}
                   HEREMAPS_API_KEY: ${{ secrets.HEREMAPS_API_KEY }}
                   PLANET_API_KEY: ${{ secrets.PLANET_API_KEY }}
diff --git a/.gitignore b/.gitignore
@@ -12,7 +12,7 @@ __pycache__/
 examples/notebooks/cache/
 docs/notebooks/cache/
 docs/javascripts/
-docs/maps/
+docs/html/
 docs/notebooks/*.html
 examples/notebooks/*.html
 docs/cache/

diff --git a/docs/maps.md b/docs/maps.md
@@ -2,17 +2,19 @@
 
 This page demonstrates some interactive maps created using the kepler.gl plotting backend.
 
-Create an interactive map. You can specify various parameters to initialize the map, such as `center`, `zoom`, `height`, and `widescreen`.
+## Create an interactive map
+
+You can specify various parameters to initialize the map, such as `center`, `zoom`, `height`, and `widescreen`.
 
 ```python
 import leafmap.kepler as leafmap
 m = leafmap.Map(center=[40, -100], zoom=2, height=600, widescreen=False)
 m
 ```
 
-<iframe width=1000, height=600 frameBorder=0 src="../maps/kepler.html"></iframe>
+<iframe width=760 height=500 frameBorder=0 src="../html/kepler.html"></iframe>
 
-Add a GeoJSON to the map.
+## Add a GeoJSON
 
 ```python
 m = leafmap.Map(center=[20, 0], zoom=1)
@@ -21,7 +23,7 @@ m.add_geojson(lines, layer_name="Cable lines")
 m
 ```
 
-<iframe width=1000, height=600 frameBorder=0 src="../maps/kepler_lines.html"></iframe>
+<iframe width=760 height=500 frameBorder=0 src="../html/kepler_lines.html"></iframe>
 
 Add a GeoJSON with US state boundaries to the map.
 
@@ -32,9 +34,9 @@ m.add_geojson(polygons, layer_name="Countries")
 m
 ```
 
-<iframe width=1000, height=600 frameBorder=0 src="../maps/kepler_states.html"></iframe>
+<iframe width=760 height=500 frameBorder=0 src="../html/kepler_states.html"></iframe>
 
-Add a shapefile to the map.
+## Add a shapefile
 
 ```python
 m = leafmap.Map(center=[20, 0], zoom=1)
@@ -43,9 +45,9 @@ m.add_shp(in_shp, "Countries")
 m
 ```
 
-<iframe width=1000, height=600 frameBorder=0 src="../maps/kepler_countries.html"></iframe>
+<iframe width=760 height=500 frameBorder=0 src="../html/kepler_countries.html"></iframe>
 
-Add a GeoPandas GeoDataFrame to the map.
+## Add a GeoDataFrame
 
 ```python
 import geopandas as gpd
@@ -55,4 +57,4 @@ m.add_gdf(gdf, "World cities")
 m
 ```
 
-<iframe width=1000, height=600 frameBorder=0 src="../maps/kepler_cities.html"></iframe>
+<iframe width=760 height=500 frameBorder=0 src="../html/kepler_cities.html"></iframe>
diff --git a/docs/notebooks/26_kepler_gl.ipynb b/docs/notebooks/26_kepler_gl.ipynb
@@ -73,7 +73,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "m.to_html(outfile=\"../maps/kepler.html\", read_only=False)"
+    "m.to_html(outfile=\"../html/kepler.html\", read_only=False)"
    ]
   },
   {
@@ -117,7 +117,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "m.to_html(\"../maps/kepler_lines.html\")"
+    "m.to_html(\"../html/kepler_lines.html\")"
    ]
   },
   {
@@ -145,7 +145,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "m.to_html(\"../maps/kepler_states.html\")"
+    "m.to_html(\"../html/kepler_states.html\")"
    ]
   },
   {
@@ -173,7 +173,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "m.to_html(\"../maps/kepler_countries.html\")"
+    "m.to_html(\"../html/kepler_countries.html\")"
    ]
   },
   {
@@ -229,7 +229,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "m.to_html(\"../maps/kepler_cities.html\")"
+    "m.to_html(\"../html/kepler_cities.html\")"
    ]
   }
  ],

diff --git a/examples/notebooks/26_kepler_gl.ipynb b/examples/notebooks/26_kepler_gl.ipynb
@@ -73,7 +73,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "m.to_html(outfile=\"../maps/kepler.html\", read_only=False)"
+    "m.to_html(outfile=\"../html/kepler.html\", read_only=False)"
    ]
   },
   {
@@ -117,7 +117,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "m.to_html(\"../maps/kepler_lines.html\")"
+    "m.to_html(\"../html/kepler_lines.html\")"
    ]
   },
   {
@@ -145,7 +145,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "m.to_html(\"../maps/kepler_states.html\")"
+    "m.to_html(\"../html/kepler_states.html\")"
    ]
   },
   {
@@ -173,7 +173,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "m.to_html(\"../maps/kepler_countries.html\")"
+    "m.to_html(\"../html/kepler_countries.html\")"
    ]
   },
   {
@@ -229,7 +229,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "m.to_html(\"../maps/kepler_cities.html\")"
+    "m.to_html(\"../html/kepler_cities.html\")"
    ]
   }
  ],

diff --git a/leafmap/kepler.py b/leafmap/kepler.py
@@ -286,7 +286,10 @@ def static_map(
         """
         if isinstance(self, keplergl.KeplerGl):
             if out_file is None:
-                out_file = "./cache/" + "kepler_" + random_string(3) + ".html"
+                if os.environ.get("USE_MKDOCS") is not None:
+                    out_file = "../maps/" + "kepler_" + random_string(3) + ".html"
+                else:
+                    out_file = "./cache/" + "kepler_" + random_string(3) + ".html"
             out_dir = os.path.abspath(os.path.dirname(out_file))
             if not os.path.exists(out_dir):
                 os.makedirs(out_dir)

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -47,7 +47,7 @@ nav:
     - Installation: installation.md
     - Get Started: get-started.md
     - Usage: notebooks/00_key_features.ipynb
-    - Interactive maps: maps.md
+    - Interactive Maps: maps.md
     - Tutorials: tutorials.md
     - Contributing: contributing.md
     - FAQ: faq.md