Added Docs CI, fixed minor docs errors

Signed-off-by: Omkar Phansopkar <[email protected]>

Author: OmkarPh

.github/workflows/docs-ci.yml

@@ -0,0 +1,36 @@
+name: CI Documentation
+
+on: [push, pull_request]
+
+permissions:
+  contents: read # to fetch code (actions/checkout)
+
+jobs:
+  build:
+    runs-on: ubuntu-20.04
+
+    strategy:
+      max-parallel: 4
+      matrix:
+        python-version: [3.9]
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install Dependencies
+        run:  pip install -e .[docs]
+
+      - name: Check Sphinx Documentation build minimally
+        working-directory: ./docs
+        run: sphinx-build -E -W source build
+
+      - name: Check for documentation style errors
+        working-directory: ./docs
+        run: ./scripts/doc8_style_check.sh
+

CODE_OF_CONDUCT.rst

@@ -65,7 +65,7 @@ Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may
 be reported by contacting the project team at [email protected]
-or on the Gitter chat channel at https://gitter.im/aboutcode-org/discuss .
+or on the Gitter chat channel at https://matrix.to/#/#aboutcode-org_discuss:gitter.im
 All complaints will be reviewed and investigated and will result in a
 response that is deemed necessary and appropriate to the circumstances.
 The project team is obligated to maintain confidentiality with regard to

README.md

@@ -11,7 +11,7 @@ license and other notices identified by
 and other interesting information in your code.
 
 ScanCode Workbench is based on
-[Electron](https://electron.atom.io/) and will be the primary desktop/GUI tool 
+[Electron](https://www.electronjs.org/) and will be the primary desktop/GUI tool 
 for using nexB’s [AboutCode tools](https://github.com/nexB/aboutcode). This app 
 works on Windows, OS X and Linux operating systems.
 
@@ -96,6 +96,6 @@ See the NOTICE file for more details.
 
 If you have a question, a suggestion or find a bug, enter an issue.
 
-[![Gitter chat](https://badges.gitter.im/aboutcode-org/gitter.png)](https://gitter.im/aboutcode-org/discuss)
+[![Gitter chat](https://badges.gitter.im/aboutcode-org/gitter.png)](https://matrix.to/#/#aboutcode-org_discuss:gitter.im)
 
-For questions and chats, you can join the Gitter channel at https://gitter.im/aboutcode-org/discuss
+For questions and chats, you can join the Gitter channel at https://matrix.to/#/#aboutcode-org_discuss:gitter.im

docs/scripts/doc8_style_check.sh

@@ -112,7 +112,7 @@
 # Define reusable URLs using extlinks
 extlinks = {
     'github_repo': (f"https://github.com/{github_user}/{github_repo}/%s", '%s'),
-    'scan_samples': (f"https://github.com/{github_user}/{github_repo}/tree/{github_branch}/samples/%s", '%s'),
+    'scan_samples': (f"https://github.com/{github_user}/{github_repo}/blob/{github_branch}/samples/%s", '%s'),
 }
 
 # -- Options for LaTeX output -------------------------------------------------

docs/scripts/sphinx_build_link_check.sh

@@ -7,7 +7,7 @@
 Clone, Install, Build and Run
 =============================
 
-You'll need `Node.js <https://nodejs.org/>`__ (which comes with `npm <http://npmjs.com/>`__) installed on your computer in order to build this app. (See below for a list of platform-specific requirements.) Then, from your command line:
+You'll need `Node.js <https://nodejs.org/en>`__ (which comes with `npm <https://www.npmjs.com/>`__) installed on your computer in order to build this app. (See below for a list of platform-specific requirements.) Then, from your command line:
 
 .. code-block:: bash
 
@@ -33,23 +33,23 @@ Linux
 - `Node.js <https://nodejs.org/en/download/package-manager/>`__ 12.x or later
 - npm 6.14.x or later
 - For CentOS (or linux distros without the new libstdc++) -
-   
-   -  Install the new libstdc++ library: 
+
+   -  Install the new libstdc++ library:
 
       .. code-block:: bash
-      
+
          yum provides libstdc++
-         
+
    -  Update LD_LIBRARY_PATH:
-      
+
       .. code-block:: bash
-      
+
          export LD_LIBRARY_PATH="/usr/local/lib64/:$LD_LIBRARY_PATH"
 
    -  Run the application with ``no-sandbox`` option:
-   
+
       .. code-block:: bash
-      
+
          ./ScanCode\ Workbench-linux-x64/ScanCode\ Workbench --no-sandbox
 
 MacOS
@@ -58,11 +58,11 @@ MacOS
 - Python 3.7 or later
 - `Node.js <https://nodejs.org/en/>`__ 12.x or later
 - npm 6.14.x or later
-- Command Line Tools for `Xcode <https://developer.apple.com/xcode/downloads/>`_
+- Command Line Tools for `Xcode <https://developer.apple.com/xcode/resources/>`_
    Install using:
 
    .. code-block:: bash
-   
+
       xcode-select --install
 
 Windows
@@ -73,7 +73,7 @@ Windows
   * Make sure your Python path is set. To verify, open a command prompt and see the python version:
 
    .. code-block:: bash
-   
+
       python --version
 
 - `Node.js <https://nodejs.org/en/>`__ 12.x or later

docs/source/conf.py

@@ -4,4 +4,4 @@
 
 If you have a question, a suggestion or find a bug, `enter an issue <https://github.com/nexB/scancode-workbench/issues>`__.
 
-For questions and chats, you can join the Gitter channel at https://gitter.im/aboutcode-org/discuss
+For questions and chats, you can join the Gitter channel at `<https://matrix.to/#/#aboutcode-org_discuss:gitter.im>`_

docs/source/contribute/building.rst

@@ -9,26 +9,30 @@ Download and Install
 
 - ScanCode Workbench is available for Windows, macOS and Linux -
    `ScanCode Workbench releases <https://github.com/nexB/scancode-workbench/releases>`__.
-   
-- Once downloaded, you'll find the ScanCode Workbench executable inside the ``ScanCode Workbench-<os>-<arch>`` folder. On Windows 10, for example, the executable will be named `ScanCode-Workbench.exe`.
+
+-
+   Once downloaded, you'll find the ScanCode Workbench executable inside the
+   ``ScanCode Workbench-<os>-<arch>`` folder.
+
+   On Windows 10, for example, the executable will be named `ScanCode-Workbench.exe`.
 
 .. Note::
    For CentOS (or linux distros without the new libstdc++), follow these steps:
 
    -  Install the new libstdc++ library:
-   
+
       .. code-block:: bash
-         
+
          yum provides libstdc++
 
    -  Update LD_LIBRARY_PATH:
-      
+
       .. code-block:: bash
 
          export LD_LIBRARY_PATH="/usr/local/lib64/:$LD_LIBRARY_PATH"
 
    -  Run the application with ``no-sandbox`` option:
-   
+
       .. code-block:: bash
 
          ./ScanCode\ Workbench-linux-x64/ScanCode\ Workbench --no-sandbox

docs/source/contribute/community-channels.rst

@@ -9,7 +9,10 @@ Once you have a SQLite file loaded into ScanCode Workbench, displaying the Chart
 Summary View is easy:
 
 * Select a file or directory in the Tree View on the left.
-* Click on `Chart Summary View` in the sidebar or open the :kbd:`View` menu and select :kbd:`Chart Summary View` (keyboard shortcut: :kbd:`Ctrl+Shift+D` or :kbd:`⌘+Shift+D`).
+*
+  Click on `Chart Summary View` in the sidebar or open the
+  :kbd:`View` menu and select :kbd:`Chart Summary View`
+  (keyboard shortcut: :kbd:`Ctrl+Shift+D` or :kbd:`⌘+Shift+D`).
 
 Select an attribute
 ===================
@@ -36,4 +39,4 @@ directory or file.
 
 .. figure:: data/chart-summary-filetree.gif
 
-For entire UI reference, Read :ref:`chart-summary-view` 
+For entire UI reference, Read :ref:`chart-summary-view`