Merge pull request #1630 from ocefpaf/docs

Build docs again.

Author: ocefpaf

.github/workflows/deploy-docs.yml

@@ -0,0 +1,38 @@
+name: Publish Docs
+
+on: ["push", "pull_request"]
+
+jobs:
+  run:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Setup Micromamba
+      uses: mamba-org/provision-with-micromamba@v14
+      with:
+        environment-file: false
+
+    - name: Create environment
+      shell: bash -l {0}
+      run: |
+        micromamba create --name TEST python=3 --file requirements.txt --file requirements-dev.txt --channel conda-forge
+        micromamba activate TEST
+        pip install -e . --no-deps --force-reinstall
+
+    - name: Build documentation
+      shell: bash -l {0}
+      run: |
+        set -e
+        micromamba activate TEST
+        cp examples/Quickstart.ipynb docs/quickstart.ipynb
+        pushd docs
+        make clean html linkcheck
+        popd
+
+    - name: GitHub Pages action
+      if: ${{ github.event_name == 'release' }}
+      uses: peaceiris/actions-gh-pages@v3
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: docs/_build/html/

.github/workflows/test_code.yml

@@ -8,14 +8,14 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, windows-latest]
-        python-version: ["3.7", "3.10"]
+        python-version: ["3.7", "3.11"]
       fail-fast: false
 
     steps:
     - uses: actions/checkout@v3
 
     - name: Setup Micromamba
-      uses: mamba-org/provision-with-micromamba@v13
+      uses: mamba-org/provision-with-micromamba@v14
       with:
         environment-file: false
 

.github/workflows/test_code_notebooks.yml

@@ -10,7 +10,7 @@ jobs:
     - uses: actions/checkout@v3
 
     - name: Setup Micromamba
-      uses: mamba-org/provision-with-micromamba@v13
+      uses: mamba-org/provision-with-micromamba@v14
       with:
         environment-file: false
 

.github/workflows/test_latest_branca.yml

@@ -10,7 +10,7 @@ jobs:
     - uses: actions/checkout@v3
 
     - name: Setup Micromamba
-      uses: mamba-org/provision-with-micromamba@v13
+      uses: mamba-org/provision-with-micromamba@v14
       with:
         environment-file: false
 

.github/workflows/test_selenium.yml

@@ -10,7 +10,7 @@ jobs:
     - uses: actions/checkout@v3
 
     - name: Setup Micromamba
-      uses: mamba-org/provision-with-micromamba@v13
+      uses: mamba-org/provision-with-micromamba@v14
       with:
         environment-file: false
 

.github/workflows/test_style_notebooks.yml

@@ -10,7 +10,7 @@ jobs:
     - uses: actions/checkout@v3
 
     - name: Setup Micromamba
-      uses: mamba-org/provision-with-micromamba@v13
+      uses: mamba-org/provision-with-micromamba@v14
       with:
         environment-file: false
 

.travis.yml

@@ -58,7 +58,7 @@ using Jupyter's nbviewer:
 
 https://nbviewer.jupyter.org/github/python-visualization/folium/tree/main/examples/
 
-https://nbviewer.jupyter.org/github/python-visualization/folium_contrib/tree/master/notebooks/
+https://nbviewer.org/github/python-visualization/folium_contrib/tree/main/notebooks/
 
 Contributing
 ------------

README.rst

@@ -245,3 +245,8 @@
 
 # How to display URL addresses: 'footnote', 'no', or 'inline'.
 #texinfo_show_urls = 'footnote'
+
+# Ignore tile URLs
+linkcheck_ignore = [
+  r"https://free.*",
+]

docs/conf.py

@@ -349,7 +349,7 @@
     "## Vincent/Vega and Altair/VegaLite Markers\n",
     "\n",
     "`folium` enables passing any HTML object as a popup,\n",
-    "including [`bokeh`](https://bokeh.pydata.org/en/latest/) plots,\n",
+    "including [`bokeh`](https://docs.bokeh.org/en/latest/) plots,\n",
     "but there is a built-in support for [vincent](https://github.com/wrobstory/vincent) and [altair](https://altair-viz.github.io) visualizations to any marker type, with the visualization as the popover."
    ]
   },
@@ -422,7 +422,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "For more information about popups, please visit [Popups.ipynb](https://nbviewer.jupyter.org/github/python-visualization/folium/blob/main/examples/Popups.ipynb)"
+    "For more information about popups, please visit [Popups.ipynb](https://nbviewer.org/github/python-visualization/folium/blob/main/examples/Popups.ipynb)"
    ]
   },
   {
@@ -489,7 +489,7 @@
    "source": [
     "## Choropleth maps\n",
     "\n",
-    "Choropleth can be easily created by binding the data between Pandas DataFrames/Series and Geo/TopoJSON geometries. [Color Brewer](http://colorbrewer2.org/) sequential color schemes are built-in to the library, and can be passed to quickly visualize different combinations."
+    "Choropleth can be easily created by binding the data between Pandas DataFrames/Series and Geo/TopoJSON geometries. [Color Brewer](https://colorbrewer2.org/) sequential color schemes are built-in to the library, and can be passed to quickly visualize different combinations."
    ]
   },
   {
@@ -759,7 +759,7 @@
    "source": [
     "For more examples and use cases please take a look at the gallery:\n",
     "\n",
-    "https://nbviewer.jupyter.org/github/python-visualization/folium_contrib/tree/main/notebooks/"
+    "https://nbviewer.org/github/python-visualization/folium_contrib/tree/main/notebooks/"
    ]
   }
  ],
@@ -779,7 +779,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.7"
+   "version": "3.10.6"
   },
   "toc": {
    "base_numbering": 1,

examples/Quickstart.ipynb

@@ -281,7 +281,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "This looks better. Our min and max values for the colorscale are much closer to the mean value now. Let's run with these values, and make a colorscale. I'm just going to use a sequential light-to-dark color palette from the [ColorBrewer](http://colorbrewer2.org/#type=sequential&scheme=Purples&n=5)."
+    "This looks better. Our min and max values for the colorscale are much closer to the mean value now. Let's run with these values, and make a colorscale. I'm just going to use a sequential light-to-dark color palette from the [ColorBrewer](https://colorbrewer2.org/#type=sequential&scheme=Purples&n=5)."
    ]
   },
   {
@@ -530,7 +530,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.1"
+   "version": "3.10.6"
   }
  },
  "nbformat": 4,

examples/plugin-Search.ipynb

@@ -975,7 +975,7 @@ class GeoJsonTooltip(GeoJsonDetail):
         Whether the tooltip should follow the mouse.
     **kwargs: Assorted.
         These values will map directly to the Leaflet Options. More info
-        available here: https://leafletjs.com/reference-1.6.0#tooltip
+        available here: https://leafletjs.com/reference.html#tooltip
 
     Examples
     --------
@@ -1028,7 +1028,7 @@ class GeoJsonPopup(GeoJsonDetail):
         This will use JavaScript's .toLocaleString() to format 'clean' values
         as strings for the user's location; i.e. 1,000,000.00 comma separators,
         float truncation, etc.
-        *Available for most of JavaScript's primitive types (any data you'll
+        Available for most of JavaScript's primitive types (any data you'll
         serve into the template).
     style: str, default None.
         HTML inline style properties like font and colors. Will be applied to
@@ -1076,7 +1076,7 @@ class Choropleth(FeatureGroup):
     on which to key the data. The 'columns' keyword does not need to be
     passed for a Pandas series.
 
-    Colors are generated from color brewer (http://colorbrewer2.org/)
+    Colors are generated from color brewer (https://colorbrewer2.org/)
     sequential palettes. By default, linear binning is used between
     the min and the max of the values. Custom binning can be achieved
     with the `bins` parameter.
@@ -1332,7 +1332,7 @@ class DivIcon(MacroElement):
     html : string
         A custom HTML code to put inside the div element.
 
-    See https://leafletjs.com/reference-1.6.0.html#divicon
+    See https://leafletjs.com/reference.html#divicon
 
     """
 
@@ -1427,8 +1427,8 @@ class ClickForLatLng(MacroElement):
     format_str : str, default 'lat + "," + lng'
         The javascript string used to format the text copied to clipboard.
         eg:
-            format_str = 'lat + "," + lng'              >> 46.558860,3.397397
-            format_str = '"[" + lat + "," + lng + "]"'  >> [46.558860,3.397397]
+        format_str = 'lat + "," + lng'              >> 46.558860,3.397397
+        format_str = '"[" + lat + "," + lng + "]"'  >> [46.558860,3.397397]
     alert : bool, default True
         Whether there should be an alert when something has been copied to clipboard.
     """

folium/features.py

@@ -141,7 +141,7 @@ class Map(JSCSSMixin, MacroElement):
         Display zoom controls on the map.
     **kwargs
         Additional keyword arguments are passed to Leaflets Map class:
-        https://leafletjs.com/reference-1.6.0.html#map
+        https://leafletjs.com/reference.html#map
 
     Returns
     -------

folium/folium.py

@@ -58,7 +58,7 @@ class FeatureGroup(Layer):
         Whether the layer will be shown on opening (only for overlays).
     **kwargs
         Additional (possibly inherited) options. See
-        https://leafletjs.com/reference-1.6.0.html#featuregroup
+        https://leafletjs.com/reference.html#featuregroup
 
     """
     _template = Template(u"""
@@ -104,7 +104,7 @@ class LayerControl(MacroElement):
           its layers so that the order is preserved when switching them on/off.
     **kwargs
         Additional (possibly inherited) options. See
-        https://leafletjs.com/reference-1.6.0.html#control-layers
+        https://leafletjs.com/reference.html#control-layers
 
     """
     _template = Template("""
@@ -403,7 +403,7 @@ class Tooltip(MacroElement):
         Whether the tooltip should follow the mouse.
     **kwargs
         These values will map directly to the Leaflet Options. More info
-        available here: https://leafletjs.com/reference-1.6.0#tooltip
+        available here: https://leafletjs.com/reference.html#tooltip
 
     """
     _template = Template(u"""
@@ -517,7 +517,7 @@ class CustomPane(MacroElement):
         determine which map elements lie over/under it. The default
         (625) corresponds to between markers and tooltips. Default
         panes and z-indexes can be found at
-        https://leafletjs.com/reference-1.6.0.html#map-pane
+        https://leafletjs.com/reference.html#map-pane
     pointer_events: bool, default False
         Whether or not layers in the pane should interact with the
         cursor. Setting to False will prevent interfering with

folium/map.py

@@ -33,7 +33,7 @@ class BeautifyIcon(JSCSSMixin, MacroElement):
 
     Examples
     --------
-    Plugin Website: https://github.com/marslan390/BeautifyMarker
+    Plugin Website: https://github.com/masajid390/BeautifyMarker
     >>> BeautifyIcon(text_color='#000', border_color='transparent',
     ...              background_color='#FFF').add_to(marker)
     >>> number_icon = BeautifyIcon(text_color='#000', border_color='transparent',

folium/plugins/beautify_icon.py

@@ -17,7 +17,7 @@ class Draw(JSCSSMixin, MacroElement):
         Name of geojson file
     position : {'topleft', 'toprigth', 'bottomleft', 'bottomright'}
         Position of control.
-        See https://leafletjs.com/reference-1.6.0.html#control
+        See https://leafletjs.com/reference.html#control
     draw_options : dict, optional
         The options used to configure the draw toolbar. See
         http://leaflet.github.io/Leaflet.draw/docs/leaflet-draw-latest.html#drawoptions

folium/plugins/draw.py

@@ -28,7 +28,7 @@ class PolyLineTextPath(JSCSSMixin, MacroElement):
     attributes: dict
         Object containing the attributes applied to the text tag.
         Check valid attributes here:
-        https://developer.mozilla.org/en-US/docs/Web/SVG/Element/text#Attributes
+        https://developer.mozilla.org/en-US/docs/Web/SVG/Element/text#attributes
         Example: {'fill': '#007DEF', 'font-weight': 'bold', 'font-size': '24'}
 
     See https://github.com/makinacorpus/Leaflet.TextPath for more information.

folium/plugins/polyline_text_path.py

@@ -156,7 +156,7 @@ class WmsTileLayer(Layer):
         for setting extra tileLayer.wms parameters or as extra parameters in
         the WMS request.
 
-    See https://leafletjs.com/reference-1.6.0.html#tilelayer-wms
+    See https://leafletjs.com/reference.html#tilelayer-wms
     """
     _template = Template(u"""
         {% macro script(this, kwargs) %}
@@ -225,7 +225,7 @@ class ImageOverlay(Layer):
     show: bool, default True
         Whether the layer will be shown on opening (only for overlays).
 
-    See https://leafletjs.com/reference-1.6.0.html#imageoverlay for more
+    See https://leafletjs.com/reference.html#imageoverlay for more
     options.
 
     """
@@ -311,7 +311,7 @@ class VideoOverlay(Layer):
         Whether the layer will be shown on opening (only for overlays).
     **kwargs:
         Other valid (possibly inherited) options. See:
-        https://leafletjs.com/reference-1.6.0.html#videooverlay
+        https://leafletjs.com/reference.html#videooverlay
 
     """
     _template = Template(u"""