👷 Build docs and check all links

veit · veit · commit 2bd0a8990304 · 2024-10-03T17:59:36.000+02:00
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -0,0 +1,23 @@
+name: docs
+
+on:
+  pull_request:
+  push:
+    branches: [main]
+
+jobs:
+  docs:
+    name: Build docs and check links
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: pandoc/actions/setup@v1
+    - uses: ts-graphviz/setup-graphviz@v2
+    - uses: actions/setup-python@v5
+      with:
+        cache: pip
+        # Keep in sync with .readthedocs.yaml
+        python-version-file: .python-version
+    - run: python -m pip install -e ".[docs]"
+    - run: python -m sphinx -nb html docs/ docs/_build/html
+    - run: python -m sphinx -b linkcheck docs/ docs/_build/html
diff --git a/.python-version b/.python-version
@@ -0,0 +1 @@
+3.12
diff --git a/docs/bokeh/geographic-plots.ipynb b/docs/bokeh/geographic-plots.ipynb
@@ -336,7 +336,7 @@
     "Es ist oft nützlich, Datensätze mit ihrem realen Kontext in Beziehung setzen zu können. Ihr könnt geografische Daten wie jede andere Art von Daten darstellen, z.B. für [Texas Unemployment example](https://docs.bokeh.org/en/latest/docs/examples/topics/geo/texas_hover_map.html), aber Bokeh bietet auch mehrere spezialisierte Mechanismen zum Zeichnen von Daten in geografischen Koordinaten:\n",
     "\n",
     "* [TileSource](https://docs.bokeh.org/en/latest/docs/user_guide/topics/geo.html#tile-provider-maps), insbesondere WMTSTileSource: Ermöglicht die Überlagerung von Daten von beliebigen Karten-Tiles-Servern, einschließlich\n",
-    "[Stamen](http://maps.stamen.com), \n",
+    "[Stamen](https://maps.stamen.com), \n",
     "[OpenStreetMap](https://www.openstreetmap.org), \n",
     "[ESRI](https://www.esri.com/de-de/home), \n",
     "und benutzerdefinierte Server.\n",
diff --git a/docs/bokeh/index.rst b/docs/bokeh/index.rst
@@ -54,7 +54,7 @@ Optionale Erweiterungen
 
 Es gibt Erweiterungen für Bokeh für die folgenden Funktionen:
 
-`NodeJS <https://nodejs.org/de>`_
+`NodeJS <https://nodejs.org/en/>`_
     Notwendig zum Erweitern von Bokeh oder zum Definieren von
     ``CustomJS``-Implementierungen in CoffeeScript oder TypeScript
 `pandas <https://pandas.pydata.org/>`_
diff --git a/docs/bokeh/integration/datashader.ipynb b/docs/bokeh/integration/datashader.ipynb
@@ -1447,9 +1447,7 @@
     "\n",
     "Ihr könnt auch problemlos andere Bokeh-Daten im selben Plot überlagern oder `map`-Tiles für geographische Daten im Web Mercator-Format in den Hintergrund setzen.\n",
     "\n",
-    "Datashader funktioniert ähnlich auch für line-Plots (z.B. Zeitreihen und Trajektorien). So können alle Datenpunkte verwendet werden, ohne selbst eine Unterteilung treffen zu müssen. Es kann auch Rasterdaten (z.B. Satellitenwetterdaten) verwenden, um es in einem angeforderten Grid zu rastern, das dann analysiert oder eingefärbt oder mit anderen Nicht-Rasterdaten kombiniert werden kann. Wenn ihr beispielsweise Höhenangaben in Rasterform und Einkommensdaten als einzelne Punkte habt, könnt ihr leicht alle Pixel zeichnen, bei denen das durchschnittliche Einkommen über einem bestimmten Schwellenwert liegt und die Höhe unter einem bestimmten Wert liegt. Dies wäre mit einem traditionellen Workflow nur sehr schwierig auszudrücken.\n",
-    "\n",
-    "Weitere Informationen findet ihr unter [anaconda.org/jbednar/notebooks](https://anaconda.org/jbednar/notebooks)."
+    "Datashader funktioniert ähnlich auch für line-Plots (z.B. Zeitreihen und Trajektorien). So können alle Datenpunkte verwendet werden, ohne selbst eine Unterteilung treffen zu müssen. Es kann auch Rasterdaten (z.B. Satellitenwetterdaten) verwenden, um es in einem angeforderten Grid zu rastern, das dann analysiert oder eingefärbt oder mit anderen Nicht-Rasterdaten kombiniert werden kann. Wenn ihr beispielsweise Höhenangaben in Rasterform und Einkommensdaten als einzelne Punkte habt, könnt ihr leicht alle Pixel zeichnen, bei denen das durchschnittliche Einkommen über einem bestimmten Schwellenwert liegt und die Höhe unter einem bestimmten Wert liegt. Dies wäre mit einem traditionellen Workflow nur sehr schwierig auszudrücken."
    ]
   }
  ],
diff --git a/docs/bokeh/integration/holoviews/geoviews.ipynb b/docs/bokeh/integration/holoviews/geoviews.ipynb
@@ -37,7 +37,7 @@
    "source": [
     "### xarray-Beispiel\n",
     "\n",
-    "Für das folgende Beispiel benötigen wir ebenfalls noch [xarray](http://xarray.pydata.org/en/stable/). Es kann mit Spack installiert werden mit:\n",
+    "Für das folgende Beispiel benötigen wir ebenfalls noch [xarray](https://docs.xarray.dev/en/stable/). Es kann mit Spack installiert werden mit:\n",
     "\n",
     "``` bash\n",
     "$ spack install py-xarray\n",
diff --git a/docs/bokeh/integration/holoviews/hvplot/examples.ipynb b/docs/bokeh/integration/holoviews/hvplot/examples.ipynb
@@ -2495,15 +2495,15 @@
     "* [bar()](#bar()) zeichnet ein Flächendiagramm ähnlich einem Liniendiagramm, außer dass der Bereich unter der Kurve gefüllt und optional gestapelt wird\n",
     "* [bivariate()](#bivariate()) zeichnet ein Flächendiagramm ähnlich einem Liniendiagramm, außer dass der Bereich unter der Kurve gefüllt und optional gestapelt wird\n",
     "* [box()](#box()) zeichnet ein [Box-Whisker-Diagramm](https://de.wikipedia.org/wiki/Box-Plot), in dem die Verteilung einer oder mehrerer Variablen verglichen wird\n",
-    "* [heatmap()](#heatma()p) zeichnet Hex-Bins\n",
-    "* [hexbins()](#hexbins()) zeichnet die Verteilung eines oder mehrerer Histogramme als Satz von Containern\n",
-    "* [histogram()](#histogram()) zeichnet die Kernel-Dichteschätzung einer oder mehrerer Variablen\n",
+    "* `heatmap()` zeichnet Hex-Bins\n",
+    "* `hexbins()` zeichnet die Verteilung eines oder mehrerer Histogramme als Satz von Containern\n",
+    "* `histogram()` zeichnet die Kernel-Dichteschätzung einer oder mehrerer Variablen\n",
     "* [kde()](#kde(),-density()) zeichnet die Kernel-Dichteschätzung einer oder mehrerer Variablen\n",
-    "* [line()](#line()) zeichnet ein Liniendiagramm (z.B. für eine Zeitreihe)\n",
+    "* `line()` zeichnet ein Liniendiagramm (z.B. für eine Zeitreihe)\n",
     "* [step()](#step()) zeichnet ein Schrittdiagramm, das einem Liniendiagramm ähnelt\n",
     "* [scatter()](#scatter()) zeichnet ein Streudiagramm, in dem zwei Variablen verglichen werden \n",
     "* [table()](#table()) erzeugt eine SlickGrid-Datentabelle\n",
-    "* [violin()](#violin()) zeichnet ein Violinen-Diagramm, in dem die Verteilung einer oder mehrerer Variablen mithilfe der Kernel-Dichteschätzung verglichen wird"
+    "* `violin()` zeichnet ein Violinen-Diagramm, in dem die Verteilung einer oder mehrerer Variablen mithilfe der Kernel-Dichteschätzung verglichen wird"
    ]
   },
   {
diff --git a/docs/bokeh/integration/index.rst b/docs/bokeh/integration/index.rst
@@ -2,7 +2,7 @@ Bokeh-Integration
 =================
 
 Bokeh spielt auch mit anderen Visualisierungsbibliotheken wie `Vaex
-<https://github.com/vaexio/vaex>`_, `HoloViews <http://holoviews.org/>`_
+<https://github.com/vaexio/vaex>`_, `HoloViews <https://holoviews.org>`_
 oder `Datashader <datashader.ipynb>`_ zusammen.
 
 .. toctree::
diff --git a/docs/bokeh/styling-theming.ipynb b/docs/bokeh/styling-theming.ipynb
@@ -736,7 +736,7 @@
     "\n",
     "Achsenobjekte verfügen über viele konfigurierbare Eigenschaften, mit denen die meisten visuellen Aspekte einer Achse gesteuert werden können. Diese können nach Funktion mit Präfix gruppiert werden:\n",
     "\n",
-    "[Line Properties](https://docs.bokeh.org/en/latest/docs/user_guide/styling/visuals.html#line-properties), z.B.\n",
+    "[Line Properties](https://docs.bokeh.org/en/latest/docs/user_guide/styling/visuals.html#ug-styling-line-properties), z.B.\n",
     "* `axis_line_width`\n",
     "* `major_tick_line_dash`, `major_tick_in and major_tick_out`\n",
     "* `minor_tick_line_width`, `minor_tick_in and minor_tick_out`\n",
@@ -1072,7 +1072,7 @@
     "\n",
     "Rastereigenschaften in Bokeh haben zwei mögliche Präfixe:\n",
     "\n",
-    "* `grid`-Eigenschaften (also [line properties](http://bokeh.pydata.org/en/latest/docs/user_guide/styling.html#line-properties)) steuern die *Gitternetzlinien*\n",
+    "* `grid`-Eigenschaften (also [line properties](https://docs.bokeh.org/en/latest/docs/user_guide/styling/visuals.html#ug-styling-line-properties)) steuern die *Gitternetzlinien*\n",
     "* `band`-Eigenschaften (also [fill properties](https://docs.bokeh.org/en/latest/docs/user_guide/styling/visuals.html#ug-styling-fill-properties)) steuern die Streifen zwischen den Gitterlinien\n",
     "\n",
     "Im ersten ersten Beispiel deaktivieren wir die vertikalen Gitterlinien (indem wir die Linienfarbe auf `None`) und das horizontale Gitter hell und gestrichelt setzen."
diff --git a/docs/conf.py b/docs/conf.py
@@ -138,12 +138,21 @@
     "jupyter-tutorial": ("https://jupyter-tutorial.readthedocs.io/en/latest/", None),
     "python4datascience": ("https://python4data.science/en/latest/", None),
     "cusy-design": ("https://www.cusy.design/de/latest/", None),
-    "bokeh": ("https://docs.bokeh.org/en/latest/", None),
+    "bokeh": ("https://docs.bokeh.org/en/latest", None),
     "pandas": ("https://pandas.pydata.org/pandas-docs/stable/", None),
 }
 
+linkcheck_ignore = [
+    r"https://maps.stamen.com",
+    # 403 Client Error: Forbidden
+    r"https://sourceforge.net/projects/safemap/",
+    # Anchor not found
+    r"https://docs.bokeh.org/en/latest/docs/user_guide/styling/visuals.html*",
+]
+
 linkcheck_allowed_redirects = {
     r"https://results\.pre-commit\.ci/latest/github/veit/pyviz-tutorial/main": r"https://results\.pre-commit\.ci/run/github/*",
+    r"https://github.com/veit/pyviz-tutorial/fork": r"https://github.com/login?.*",
 }
 
 
diff --git a/docs/d3js/bqplot/index.rst b/docs/d3js/bqplot/index.rst
@@ -10,7 +10,7 @@ Graphics (Statistics and Computing)
 
 .. seealso::
 
-   * `Docs <https://bqplot.readthedocs.io/>`_
+   * `Docs <https://bqplot.readthedocs.io/en/latest/>`_
    * `GitHub <https://github.com/bqplot/bqplot>`_
    * `Gallery <https://bqplot.github.io/bqplot-gallery/>`_
 
diff --git a/docs/matplotlib/cartopy/install.rst b/docs/matplotlib/cartopy/install.rst
@@ -19,7 +19,7 @@ Cartopy installation
 
    The following packages are also installed:
 
-   * `gdal <https://gdal.org/>`_
+   * `gdal <https://gdal.org/en/latest/>`_
    * :doc:`/matplotlib/index`
    * `OWSLib <https://geopython.github.io/OWSLib/>`_
    * `Pillow <https://pillow.readthedocs.io/en/stable/>`_
diff --git a/docs/matplotlib/graph-tool.ipynb b/docs/matplotlib/graph-tool.ipynb
@@ -100,7 +100,7 @@
    "id": "f12cc83e",
    "metadata": {},
    "source": [
-    "A graph can be changed from directed to undirected at any time using the [set_directed()](https://graph-tool.skewed.de/static/doc/graph_tool.html#graph_tool.Graph.set_directed) method. The direction of the graph can be queried using the [is_directed()](https://graph-tool.skewed.de/static/doc/graph_tool.html#graph_tool.Graph.is_directed) method:"
+    "A graph can be changed from directed to undirected at any time using the [set_directed()](https://graph-tool.skewed.de/static/doc/autosummary/graph_tool.Graph.html#graph_tool.Graph.set_directed) method. The direction of the graph can be queried using the [is_directed()](https://graph-tool.skewed.de/static/doc/autosummary/graph_tool.Graph.html#graph_tool.Graph.is_directed) method:"
    ]
   },
   {
@@ -120,7 +120,7 @@
    "id": "ea48046c",
    "metadata": {},
    "source": [
-    "Once a graph has been created, it can be filled with nodes and edges. A vertex can be added using the [add_vertex()](https://graph-tool.skewed.de/static/doc/graph_tool.html#graph_tool.Graph.add_vertex) method, which returns an instance of a [vertex](https://graph-tool.skewed.de/static/doc/graph_tool.html#graph_tool.Vertex) class, also known as a *vertex descriptor*. For example, the following code creates two nodes and returns *vertex descriptors* that are stored in the variables `v1` and `v2`:"
+    "Once a graph has been created, it can be filled with nodes and edges. A vertex can be added using the [add_vertex()](https://graph-tool.skewed.de/static/doc/autosummary/graph_tool.Graph.html#graph_tool.Graph.add_vertex) method, which returns an instance of a [vertex](https://graph-tool.skewed.de/static/doc/autosummary/graph_tool.Vertex.html) class, also known as a *vertex descriptor*. For example, the following code creates two nodes and returns *vertex descriptors* that are stored in the variables `v1` and `v2`:"
    ]
   },
   {
diff --git a/docs/matplotlib/graphviz/libs-tools.rst b/docs/matplotlib/graphviz/libs-tools.rst
@@ -10,7 +10,7 @@ Python libraries
     Python interface to Graphviz similar to :doc:`../networkx`
 `GvGen <https://github.com/stricaud/gvgen>`_
     Python class for generating dot files
-`pytm <https://github.com/izar/pytm/>`_
+`pytm <https://github.com/OWASP/pytm>`_
     Framework for modelling buffer overflows, SQL injections, CSRF :abbr:`etc.
     (et cetera)`
 :doc:`../graph-tool`
diff --git a/docs/matplotlib/plotnine/examples.ipynb b/docs/matplotlib/plotnine/examples.ipynb
@@ -80,7 +80,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "[plotnine.aes](https://plotnine.org/reference/aes.html) creates aesthetic mappings with *miles per gallon* `mpg` on the y-axis and *weight of cars* `wt` on the x-axis. [plotnine.geoms.geom_point](https://plotnine.readthedocs.io/en/stable/generated/plotnine.geoms.geom_point.html) then creates a scatter plot."
+    "[plotnine.aes](https://plotnine.org/reference/aes.html) creates aesthetic mappings with *miles per gallon* `mpg` on the y-axis and *weight of cars* `wt` on the x-axis. [plotnine.geom_point](https://plotnine.org/reference/geom_point.html) then creates a scatter plot."
    ]
   },
   {
@@ -182,7 +182,7 @@
    "source": [
     "5. Display in separated fields\n",
     "\n",
-    "   The fields can be separated with [plotnine.facets.facet_wrap](https://plotnine.readthedocs.io/en/stable/generated/plotnine.facets.facet_wrap.html)."
+    "   The fields can be separated with [plotnine.facet_wrap](https://plotnine.org/reference/facet_wrap.html)."
    ]
   },
   {
diff --git a/docs/matplotlib/plotnine/index.rst b/docs/matplotlib/plotnine/index.rst
@@ -1,14 +1,14 @@
 plotnine
 ========
 
-`plotnine <https://plotnine.readthedocs.io/en/stable/>`_ implements `The Grammar
-of Graphics <https://link.springer.com/book/10.1007/0-387-28695-0>`_  Python
-based on `ggplot2 <https://ggplot2.tidyverse.org/>`_. The grammar allows the
-simple description of even complex graphics.
+`plotnine <https://plotnine.org>`_ implements `The Grammar of Graphics
+<https://link.springer.com/book/10.1007/0-387-28695-0>`_  Python based on
+`ggplot2 <https://ggplot2.tidyverse.org/>`_. The grammar allows the simple
+description of even complex graphics.
 
 .. seealso::
 
-   `plotnine documentation <https://plotnine.readthedocs.io/en/stable/>`_
+   `plotnine documentation <https://plotnine.org>`_
         API reference, gallery, tutorials :abbr:`etc (et cetera)`.
    `ggplot2 documentation <https://ggplot2.tidyverse.org/reference/index.html>`_
         plotnine uses a similar API and pipeline as ggplt2.
diff --git a/docs/overview.rst b/docs/overview.rst

Original file line number	Diff line number	Diff line change
`@@ -1447,9 +1447,7 @@`
`1447`	`1447`	`"\n",`
`1448`	`1448`	"Ihr könnt auch problemlos andere Bokeh-Daten im selben Plot überlagern oder `map`-Tiles für geographische Daten im Web Mercator-Format in den Hintergrund setzen.\n",
`1449`	`1449`	`"\n",`
`1450`		- "Datashader funktioniert ähnlich auch für line-Plots (z.B. Zeitreihen und Trajektorien). So können alle Datenpunkte verwendet werden, ohne selbst eine Unterteilung treffen zu müssen. Es kann auch Rasterdaten (z.B. Satellitenwetterdaten) verwenden, um es in einem angeforderten Grid zu rastern, das dann analysiert oder eingefärbt oder mit anderen Nicht-Rasterdaten kombiniert werden kann. Wenn ihr beispielsweise Höhenangaben in Rasterform und Einkommensdaten als einzelne Punkte habt, könnt ihr leicht alle Pixel zeichnen, bei denen das durchschnittliche Einkommen über einem bestimmten Schwellenwert liegt und die Höhe unter einem bestimmten Wert liegt. Dies wäre mit einem traditionellen Workflow nur sehr schwierig auszudrücken.\n",
`1451`		`- "\n",`
`1452`		`- "Weitere Informationen findet ihr unter [anaconda.org/jbednar/notebooks](https://anaconda.org/jbednar/notebooks)."`
	`1450`	+ "Datashader funktioniert ähnlich auch für line-Plots (z.B. Zeitreihen und Trajektorien). So können alle Datenpunkte verwendet werden, ohne selbst eine Unterteilung treffen zu müssen. Es kann auch Rasterdaten (z.B. Satellitenwetterdaten) verwenden, um es in einem angeforderten Grid zu rastern, das dann analysiert oder eingefärbt oder mit anderen Nicht-Rasterdaten kombiniert werden kann. Wenn ihr beispielsweise Höhenangaben in Rasterform und Einkommensdaten als einzelne Punkte habt, könnt ihr leicht alle Pixel zeichnen, bei denen das durchschnittliche Einkommen über einem bestimmten Schwellenwert liegt und die Höhe unter einem bestimmten Wert liegt. Dies wäre mit einem traditionellen Workflow nur sehr schwierig auszudrücken."
`1453`	`1451`	`]`
`1454`	`1452`	`}`
`1455`	`1453`	`],`