Merge pull request #3636 from nexB/fix-doc-build

Fix SCTK doc build

.github/ISSUE_TEMPLATE/config.yml

@@ -1,8 +1,8 @@
 blank_issues_enabled: true
 contact_links:
-  - name: Gitter Chat
-    url: https://gitter.im/aboutcode-org/discuss
+  - name: Matrix Chat
+    url: https://matrix.to/#/#aboutcode-org_discuss:gitter.im
     about: Please ask questions here.
   - name: Code Of Conduct
     url: https://github.com/nexB/scancode-toolkit/blob/develop/CODE_OF_CONDUCT.rst
-    about: This space is protected by our Code Of Conduct. 
+    about: This space is protected by our Code Of Conduct.

.github/PULL_REQUEST_TEMPLATE.md

@@ -17,8 +17,8 @@ Make sure these boxes are checked before your pull request (PR) is ready to be r
 * [ ] Tests pass -- look for a green checkbox ✔️ a few minutes after opening your PR
   Run [tests](https://scancode-toolkit.readthedocs.io/en/latest/contribute/contrib_dev.html#running-tests) locally to check for errors. 
 * [ ] Commits are in uniquely-named feature branch and has no merge conflicts 📁
-* [ ] Looked for possible updates in documentation and added updates if applicable
-* [ ] Updated CHANGELOG.rst
+* [ ] Updated documentation pages (if applicable)
+* [ ] Updated CHANGELOG.rst (if applicable)
 <!--
 We're happy to help you get this ready -- don't be afraid to ask for help, and **don't be discouraged**
 if your tests fail at first!

.github/workflows/docs-ci.yml

@@ -23,9 +23,6 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
 
-      - name: Give permission to run scripts
-        run: chmod +x ./docs/scripts/doc8_style_check.sh
-
       - name: Install Dependencies
         run:  pip install -e .[docs]
 

.readthedocs.yml

@@ -5,6 +5,12 @@
 # Required
 version: 2
 
+# Build in latest ubuntu/python
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
 # Build PDF & ePub
 formats:
   - epub

configure

@@ -159,7 +159,7 @@ PROD_REQUIREMENTS="scancode_toolkit*.whl"
 VIRTUALENV_DIR=venv
 
 # Cleanable files and directories to delete with the --clean option
-CLEANABLE="build dist venv .cache .eggs"
+CLEANABLE="tmp build dist venv .cache .eggs"
 
 # extra  arguments passed to pip
 PIP_EXTRA_ARGS=" "

configure.bat

@@ -35,7 +35,7 @@ set "REL_REQUIREMENTS=--requirement etc/scripts/requirements.txt"
 set "VIRTUALENV_DIR=venv"
 
 @rem # Cleanable files and directories to delete with the --clean option
-set "CLEANABLE=build dist venv .cache .eggs"
+set "CLEANABLE=tmp build dist venv .cache .eggs"
 
 @rem # extra  arguments passed to pip
 set "PIP_EXTRA_ARGS= "

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.
 

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"]