From baabb889fc6b32a8c9b69e3598c7f19be159d67f Mon Sep 17 00:00:00 2001 From: Bill Little Date: Mon, 25 Nov 2024 23:55:49 +0000 Subject: [PATCH] docs: resolve unnecessary linkcheck redirects (#1226) * docs: resolve unnecessary linkcheck redirects * add changelog news fragment --- changelog/1226.documentation.rst | 1 + docs/src/overview.rst | 6 +++--- docs/src/quick_start.rst | 2 +- docs/src/reference/bindings.rst | 4 ++-- docs/src/reference/environment.rst | 2 +- docs/src/reference/glossary.rst | 10 +++++----- src/geovista/examples/scalar_data/from_tiff__dem.py | 4 ++-- src/geovista/examples/scalar_data/from_tiff__rgb.py | 2 +- src/geovista/examples/warp/from_unstructured__fvcom.py | 2 +- .../examples/warp/from_unstructured__lfric_orog.py | 2 +- .../examples/warp/from_unstructured__lfric_orog_eqc.py | 2 +- 11 files changed, 19 insertions(+), 18 deletions(-) create mode 100644 changelog/1226.documentation.rst diff --git a/changelog/1226.documentation.rst b/changelog/1226.documentation.rst new file mode 100644 index 00000000..4aef73f8 --- /dev/null +++ b/changelog/1226.documentation.rst @@ -0,0 +1 @@ +Resolved unnecessary ``linkcheck`` URL redirects. (:user:`bjlittle`) diff --git a/docs/src/overview.rst b/docs/src/overview.rst index 49c0d3ac..49ffc4c7 100644 --- a/docs/src/overview.rst +++ b/docs/src/overview.rst @@ -74,7 +74,7 @@ PyVista in a Nutshell .. figure:: _static/images/pyvista-examples.png :figclass: margin - :target: https://docs.pyvista.org/version/stable/examples/ + :target: https://docs.pyvista.org/examples/ :name: pyvista-figure :alt: PyVista Examples @@ -110,6 +110,6 @@ Thanks for your patience 🙏 Page link URL resources in alphabetical order: .. _Jupyter: https://jupyter.org/ -.. _Mesh data structures: https://docs.pyvista.org/version/stable/examples/index.html#mesh-creation +.. _Mesh data structures: https://docs.pyvista.org/examples/index.html#mesh-creation .. _ParaView: https://www.paraview.org/ -.. _filtering algorithms: https://docs.pyvista.org/version/stable/examples/index.html#filtering +.. _filtering algorithms: https://docs.pyvista.org/examples/index.html#filtering diff --git a/docs/src/quick_start.rst b/docs/src/quick_start.rst index ed18102b..24c04485 100644 --- a/docs/src/quick_start.rst +++ b/docs/src/quick_start.rst @@ -350,4 +350,4 @@ If so, then let's explore the :ref:`next steps ` on your .. _Plymouth Sound and Tamar River: https://www.google.com/maps/place/Plymouth+Sound/@50.3337382,-4.2215988,12z/data=!4m5!3m4!1s0x486c93516bbce307:0xded7654eaf4f8f83!8m2!3d50.3638359!4d-4.1441365 .. _Robinson: https://proj4.org/en/stable/operations/projections/robin.html .. _WAVEWATCH III: https://github.com/NOAA-EMC/WW3 -.. _threshold: https://docs.pyvista.org/version/stable/api/core/_autosummary/pyvista.DataSetFilters.threshold.html#pyvista.DataSetFilters.threshold +.. _threshold: https://docs.pyvista.org/api/core/_autosummary/pyvista.datasetfilters.threshold diff --git a/docs/src/reference/bindings.rst b/docs/src/reference/bindings.rst index 4f0ec240..9c1eb628 100644 --- a/docs/src/reference/bindings.rst +++ b/docs/src/reference/bindings.rst @@ -150,5 +150,5 @@ Primary keyboard and mouse bindings that control the rendered scene. Page link URL resources in alphabetical order: -.. _isometric camera: https://docs.pyvista.org/version/stable/api/plotting/_autosummary/pyvista.Plotter.view_isometric.html -.. _pyvista keyboard bindings: https://docs.pyvista.org/version/stable/api/plotting/plotting.html#plotting +.. _isometric camera: https://docs.pyvista.org/api/plotting/_autosummary/pyvista.plotter.view_isometric +.. _pyvista keyboard bindings: https://docs.pyvista.org/api/plotting/plotting.html#plotting diff --git a/docs/src/reference/environment.rst b/docs/src/reference/environment.rst index 45eb7c76..e1d202bb 100644 --- a/docs/src/reference/environment.rst +++ b/docs/src/reference/environment.rst @@ -122,5 +122,5 @@ Notable third-party environment variables that influence the behaviour of .. _SPEC 1: https://scientific-python.org/specs/spec-0001/ .. _XDG Base Directory Specification: https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html .. _lazy-loader: https://github.com/scientific-python/lazy-loader -.. _GitHub Action: https://docs.github.com/en/actions/learn-github-actions/variables#default-environment-variables +.. _GitHub Action: https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/store-information-in-variables#default-environment-variables .. _Read the Docs: https://docs.readthedocs.io/en/stable/reference/environment-variables.html#envvar-READTHEDOCS diff --git a/docs/src/reference/glossary.rst b/docs/src/reference/glossary.rst index bedc7bdf..b48e24d5 100644 --- a/docs/src/reference/glossary.rst +++ b/docs/src/reference/glossary.rst @@ -91,9 +91,9 @@ Say what you mean. Mean what you say. Page link URL resources in alphabetical order: -.. _PyVista threshold: https://docs.pyvista.org/version/stable/api/core/_autosummary/pyvista.DataSetFilters.threshold.html#pyvista.DataSetFilters.threshold -.. _PyVista warp_by_scalar: https://docs.pyvista.org/version/stable/api/core/_autosummary/pyvista.DataSetFilters.warp_by_scalar.html#pyvista.DataSetFilters.warp_by_scalar -.. _What is a Cell?: https://docs.pyvista.org/version/stable/user-guide/what-is-a-mesh.html#what-is-a-cell -.. _What is a Point?: https://docs.pyvista.org/version/stable/user-guide/what-is-a-mesh.html#what-is-a-point -.. _What is a Mesh?: https://docs.pyvista.org/version/stable/user-guide/what-is-a-mesh.html#what-is-a-mesh +.. _PyVista threshold: https://docs.pyvista.org/api/core/_autosummary/pyvista.datasetfilters.threshold +.. _PyVista warp_by_scalar: https://docs.pyvista.org/api/core/_autosummary/pyvista.datasetfilters.warp_by_scalar +.. _What is a Cell?: https://docs.pyvista.org/user-guide/what-is-a-mesh.html#what-is-a-cell +.. _What is a Point?: https://docs.pyvista.org/user-guide/what-is-a-mesh.html#what-is-a-point +.. _What is a Mesh?: https://docs.pyvista.org/user-guide/what-is-a-mesh.html#what-is-a-mesh .. _vtkActor: https://vtk.org/doc/nightly/html/classvtkActor.html#details diff --git a/src/geovista/examples/scalar_data/from_tiff__dem.py b/src/geovista/examples/scalar_data/from_tiff__dem.py index ab6e902d..17e2adb7 100755 --- a/src/geovista/examples/scalar_data/from_tiff__dem.py +++ b/src/geovista/examples/scalar_data/from_tiff__dem.py @@ -10,8 +10,8 @@ ----------- This example demonstrates how to render **Digital Elevation Model** (DEM) data -encoded in an `OGC GeoTIFF `_ as a -geolocated mesh. +encoded in an `OGC GeoTIFF `_ +as a geolocated mesh. 📋 Summary ^^^^^^^^^^ diff --git a/src/geovista/examples/scalar_data/from_tiff__rgb.py b/src/geovista/examples/scalar_data/from_tiff__rgb.py index a3ad4987..a27a3378 100755 --- a/src/geovista/examples/scalar_data/from_tiff__rgb.py +++ b/src/geovista/examples/scalar_data/from_tiff__rgb.py @@ -9,7 +9,7 @@ ----------- This example demonstrates how to render an -`OGC GeoTIFF `_ RGB image as a +`OGC GeoTIFF `_ RGB image as a geolocated mesh. 📋 Summary diff --git a/src/geovista/examples/warp/from_unstructured__fvcom.py b/src/geovista/examples/warp/from_unstructured__fvcom.py index 16655570..f84ab1b1 100755 --- a/src/geovista/examples/warp/from_unstructured__fvcom.py +++ b/src/geovista/examples/warp/from_unstructured__fvcom.py @@ -30,7 +30,7 @@ The warp uses :meth:`~pyvista.PolyDataFilters.compute_normals` and :meth:`~pyvista.DataSetFilters.warp_by_scalar`. See -`Computing Surface Normals `_ +`Computing Surface Normals `_ for further details. .. tags:: diff --git a/src/geovista/examples/warp/from_unstructured__lfric_orog.py b/src/geovista/examples/warp/from_unstructured__lfric_orog.py index 35527273..ce0bb1b8 100755 --- a/src/geovista/examples/warp/from_unstructured__lfric_orog.py +++ b/src/geovista/examples/warp/from_unstructured__lfric_orog.py @@ -28,7 +28,7 @@ The warp uses :meth:`~pyvista.PolyDataFilters.compute_normals` and :meth:`~pyvista.DataSetFilters.warp_by_scalar`. See -`Computing Surface Normals `_ +`Computing Surface Normals `_ for further details. .. tags:: diff --git a/src/geovista/examples/warp/from_unstructured__lfric_orog_eqc.py b/src/geovista/examples/warp/from_unstructured__lfric_orog_eqc.py index 8530b7a4..1646c8ae 100755 --- a/src/geovista/examples/warp/from_unstructured__lfric_orog_eqc.py +++ b/src/geovista/examples/warp/from_unstructured__lfric_orog_eqc.py @@ -33,7 +33,7 @@ The warp uses :meth:`~pyvista.PolyDataFilters.compute_normals` and :meth:`~pyvista.DataSetFilters.warp_by_scalar`. See -`Computing Surface Normals `_ +`Computing Surface Normals `_ for further details. .. tags::