Merge pull request #252 from compas-dev/broken_links

Fix broken links and automate checking

Author: beverlylytle

.github/workflows/deploy-n-publish.yml

@@ -31,7 +31,7 @@ jobs:
       - name: 📃 Generate docs
         if: success()
         run: |
-          invoke docs
+          invoke docs --check-links
 
           # Get branch/tag/latest name from git
           GITHUB_REF_REGEX="tags/v([0-9a-zA-Z\.\-]+)|(pull/[0-9]+)|heads/(.+)"

docs/conf.py

@@ -59,6 +59,9 @@
 # autosummary options
 autosummary_generate = True
 
+# linkcheck options
+linkcheck_ignore = [r'http://localhost:\d+/']
+
 # collect doc versions
 package_docs_root = 'https://gramaziokohler.github.io/compas_fab/'
 

docs/getting_started.rst

@@ -58,7 +58,7 @@ Working in Blender
 ==================
 
 Once **COMPAS** itself is installed for Blender following the
-`documented procedure <https://compas.dev/compas/gettingstarted/cad/blender.html>`_,
+`documented procedure <https://compas.dev/compas/latest/gettingstarted/blender.html>`_,
 **COMPAS FAB** will automatically be available as well after installing it.
 
 
@@ -130,5 +130,5 @@ Next Steps
 * :ref:`Working with backends <backends>`
 * :ref:`COMPAS FAB Examples <examples>`
 * :ref:`COMPAS FAB API Reference <reference>`
-* `COMPAS Tutorials <https://compas.dev/compas/tutorial.html>`_
-* `COMPAS API Reference <https://compas.dev/compas/api.html>`_
+* `COMPAS Tutorials <https://compas.dev/compas/latest/tutorial.html>`_
+* `COMPAS API Reference <https://compas.dev/compas/latest/api.html>`_

src/compas_fab/sensors/baumer.py

@@ -8,8 +8,7 @@
 
 
 class PosCon3D(SerialSensor):
-    """Provides an interface for the `Baumer PosCon3D edge measurement sensor
-    <http://www.baumer.com/us-en/products/distance-measurement/light-section-sensors/poscon-3d-edge-measurement/>`_.
+    """Provides an interface for the Baumer PosCon3D edge measurement sensor.
 
     The sensor has different interfaces to retrieve its data. This
     class provides access to the serial interface (RS-485). This
@@ -328,8 +327,7 @@ def adjust_to_dark_object(self, is_dark_object):
 
 
 class PosConCM(SerialSensor):
-    """Provides an interface for the `Baumer PosConCM round objects measurement sensor
-    <http://www.baumer.com/us-en/products/distance-measurement/light-section-sensors/poscon-cm-measurement-of-round-objects/>`_.
+    """Provides an interface for the Baumer PosConCM round objects measurement sensor.
 
     The sensor has different interfaces to retrieve its data. This
     class provides access to the serial interface (RS-485).