Fix broken links in SCTK docs

AyanSinhaMahapatra · AyanSinhaMahapatra · commit d6cb74f82f2a · 2024-01-11T19:54:37.000+05:30
Signed-off-by: Ayan Sinha Mahapatra &lt;ayansmahapatra@gmail.com&gt;
diff --git a/docs/source/cli-reference/basic-options.rst b/docs/source/cli-reference/basic-options.rst
@@ -580,26 +580,26 @@
 
     The ``--license-url-template`` option sets the template URL used for the license reference URLs.
 
-    The default template URL is : [https://enterprise.dejacode.com/urn/urn:dje:license:{}]
+    The default template URL is : [https://scancode-licensedb.aboutcode.org/{}]
     In a template URL, curly braces ({}) are replaced by the license key.
 
-    So, by default the license reference URL points to the dejacode page for that license.
+    So, by default the license reference URL points to the LicenseDB page for that license.
 
     A scan example using the ``--license-url-template TEXT`` option ::
 
-        scancode -clpieu --json-pp output.json samples --license-url-template https://github.com/nexB/scancode-toolkit/tree/develop/src/licensedcode/data/licenses/{}.yml
+        scancode -clpieu --json-pp output.json samples --license-url-template https://github.com/nexB/scancode-toolkit/tree/develop/src/licensedcode/data/licenses/{}.LICENSE
 
     In a normal scan, reference url for "ZLIB License" is as follows::
 
-        "reference_url": "https://enterprise.dejacode.com/urn/urn:dje:license:zlib",
+        "reference_url": "https://scancode-licensedb.aboutcode.org/zlib",
 
     After using the option in the following manner::
 
-        ``--license-url-template https://github.com/nexB/scancode-toolkit/tree/develop/src/licensedcode/data/licenses/{}``
+        ``--license-url-template https://github.com/nexB/scancode-toolkit/tree/develop/src/licensedcode/data/licenses/{}.LICENSE``
 
-    the reference URL changes to this `zlib.yml file <https://github.com/nexB/scancode-toolkit/blob/develop/src/licensedcode/data/licenses/zlib.yml>`_::
+    the reference URL changes to this `zlib.LICENSE file <https://github.com/nexB/scancode-toolkit/blob/develop/src/licensedcode/data/licenses/zlib.LICENSE>`_::
 
-        "reference_url": "https://github.com/nexB/scancode-toolkit/tree/develop/src/licensedcode/data/licenses/zlib.yml",
+        "reference_url": "https://github.com/nexB/scancode-toolkit/blob/develop/src/licensedcode/data/licenses/zlib.LICENSE",
 
     The reference URL changes for all detected licenses in the scan, across the scan result file.
 
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -54,6 +54,12 @@
     "scancode-workbench": ("https://scancode-workbench.readthedocs.io/en/latest/", None),
 }
 
+# List of regular expressions for the linkchecker to ignore
+# See https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-the-linkcheck-builder
+linkcheck_ignore = [
+    r'https://en.wikipedia.org/wiki/*',
+    r'https://matrix.to/*'
+]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
diff --git a/docs/source/contribute/contrib_dev.rst b/docs/source/contribute/contrib_dev.rst
@@ -82,7 +82,7 @@ If you have a multiprocessor machine you might want to run the tests in parallel
 typically run the tests in verbose mode with ``pytest -vvs -n4``.
 
 You can also run a subset of the test suite as shown in the CI configs
-https://github.com/nexB/scancode-toolkit/blob/develop/appveyor.yml#L6 e,g,
+https://github.com/nexB/scancode-toolkit/blob/develop/azure-pipelines.yml e,g,
 ``pytest -n 2 -vvs tests/scancode`` runs only the test scripts present in the
 ``tests/scancode`` directory. (You can give the path to a specific test script
 file there too).
diff --git a/docs/source/contribute/contrib_doc.rst b/docs/source/contribute/contrib_doc.rst
@@ -173,7 +173,7 @@ ScanCode toolkit documentation uses `Intersphinx <http://www.sphinx-doc.org/en/m
 to link to other Sphinx Documentations, to maintain links to other Aboutcode Projects.
 
 To link sections in the same documentation, standart reST labels are used. Refer
-`Cross-Referencing <http://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#ref-role>`_ for more information.
+`Cross-Referencing <https://www.sphinx-doc.org/en/master/usage/referencing.html#cross-referencing-arbitrary-locations>`_ for more information.
 
 For example::
 
diff --git a/docs/source/contribute/gsoc21_final_report.rst b/docs/source/contribute/gsoc21_final_report.rst
@@ -15,7 +15,7 @@ Project: Detect Unknown Licenses and Indirect License References in Scancode
 
 `ScanCode-toolkit <https://github.com/nexB/scancode-toolkit>`_
 
-`Project Link <https://summerofcode.withgoogle.com/projects/#6116612073062400>`_
+`Project Link <https://summerofcode.withgoogle.com/archive/2021/projects/6229596998991872>`_
 
 `Proposal <https://docs.google.com/document/d/1Dp0Hgk38RIMwITTiS-kqfikpkHRi2rjtkotA9CLw8j0/edit?usp=sharing>`_
 
diff --git a/docs/source/how-to-guides/add_new_license.rst b/docs/source/how-to-guides/add_new_license.rst
@@ -31,7 +31,7 @@ You need to create a file with:
   text as is, with the original formatting intact.
 
 - the data attributes for the license in YAML format as
-  `YAML frontmatter <https://github.com/eyeseast/python-frontmatter#python-frontmatter>`_.
+  `YAML frontmatter <https://python-frontmatter.readthedocs.io/en/latest/>`_.
 
 See an example license: `apache-2.0.LICENSE <https://github.com/nexB/scancode-toolkit/tree/develop/src/licensedcode/data/licenses/apache-2.0.LICENSE>`_
 
diff --git a/docs/source/reference/available_package_parsers.rst b/docs/source/reference/available_package_parsers.rst
@@ -646,7 +646,7 @@ parsers in scancode-toolkit during documentation builds.
      - ``pypi``
      - ``pypi_setup_py``
      - Python
-     - https://docs.python.org/3/distutils/setupscript.html
+     - https://docs.python.org/3.11/distutils/setupscript.html
    * - PyPI wheel
      - ``*.whl``
      - ``pypi``
@@ -692,7 +692,7 @@ parsers in scancode-toolkit during documentation builds.
      - None
      - https://fedoraproject.org/wiki/Changes/NewRpmDBFormat
    * - RPM installed package SQLite database
-     - ``*var/lib/rpm/rpmdb.sqlite``
+     - ``*rpm/rpmdb.sqlite``
      - ``rpm``
      - ``rpm_installed_database_sqlite``
      - None
diff --git a/docs/source/reference/license-detection-reference.rst b/docs/source/reference/license-detection-reference.rst
@@ -299,7 +299,7 @@ also has been renamed to ``extracted_license_statement``.
 
 .. _license_detections_unique:
 
-New codebase level Unique License Detection
+Codebase level Unique License Detection
 -------------------------------------------
 
 We now have a new codebase level attribute ``license_detections`` which has Unique
@@ -688,8 +688,8 @@ LicenseDetection Data
 This is referencing by LicenseDetections objects, and has one or multiple
 license matches. This is linked to the resource level detections through
 an ``identifier`` attribute present in both resource and codebase level
-detections. See the `unique license detections section <license_detections_unique>`_
-above for more details on this.
+detections. See the :ref:`license_detections_unique` above for more
+details on this.
 
 There could be a list of ambiguous detections as a summary to review.
 This is WIP, see `scancode-toolkit#3122 <https://github.com/nexB/scancode-toolkit/issues/3122>`_.
diff --git a/src/packagedcode/pypi.py b/src/packagedcode/pypi.py
@@ -643,7 +643,7 @@ class PythonSetupPyHandler(BaseExtractedPythonLayout):
     default_package_type = 'pypi'
     default_primary_language = 'Python'
     description = 'Python setup.py'
-    documentation_url = 'https://docs.python.org/3/distutils/setupscript.html'
+    documentation_url = 'https://docs.python.org/3.11/distutils/setupscript.html'
 
     @classmethod
     def parse(cls, location):
