Fixed duplicate labels & added script to clean previous sphinx build cache

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

Author: OmkarPh

.husky/pre-commit

@@ -2,3 +2,4 @@
 . "$(dirname -- "$0")/_/husky.sh"
 
 npm test
+cd docs && ./scripts/doc8_style_check.sh && ./scripts/sphinx_build_link_check.sh

docs/Makefile

@@ -20,6 +20,7 @@ docs:
 	@echo
 	@echo "Starting up the docs server..."
 	@echo
+	make clean
 	$(SPHINXAUTOBUILD) --port 8000 --watch ${SOURCEDIR} $(SOURCEDIR) "$(BUILDDIR)/html" $(SPHINXOPTS) $(O)
 
 # Catch-all target: route all unknown targets to Sphinx using the new

docs/README.md

@@ -4,7 +4,7 @@ The first step you want to do is create the python virtual environment:
 
 ```
 $ cd docs/
-$ python3 -m venv venv
+$ python -m venv venv
 $ source venv/bin/activate
 $ pip install -r requirements.txt
 ```

docs/requirements.txt

@@ -7,3 +7,4 @@ doc8>=0.11.2
 jinja2
 markupSafe
 sphinx-copybutton
+sphinx_rtd_dark_mode

docs/source/conf.py

@@ -22,7 +22,7 @@
 author = 'nexB Inc. and others'
 github_user = "nexB"
 github_repo = "scancode-workbench"
-github_branch = "update/docs"
+github_branch = "develop"
 html_favicon = '_static/favicon.ico'
 
 # -- General configuration ---------------------------------------------------
@@ -87,7 +87,7 @@
     "conf_py_path": "/docs/source/",  # path in the checkout to the docs root
 }
 
-html_css_files = ["_static/theme_overrides.css"]
+html_css_files = ["theme_overrides.css"]
 
 
 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
@@ -117,6 +117,11 @@
     'scan_samples': (f"https://github.com/{github_user}/{github_repo}/blob/{github_branch}/samples/%s", '%s'),
 }
 
+# Ignore following links in linkcheck
+linkcheck_ignore = [
+    'https://matrix.to/#/#aboutcode-org_discuss:gitter.im'
+]
+
 # -- Options for LaTeX output -------------------------------------------------
 
 latex_elements = {

docs/source/contribute/building.rst

@@ -100,7 +100,7 @@ Create python environment, make docs
    cd docs/
 
    # Setup virtual environment for python dependencies
-   python3 -m venv venv
+   python -m venv venv
    source venv/bin/activate
 
    # Install dependencies

docs/source/how-to-guides/explore-your-data/navigate-license-explorer.rst

@@ -47,7 +47,8 @@ Similarly, detection origin is a clickable icon. It determines the source of det
 - Package icon indicates that the detection belongs to a package manifest,
   you can click on it to view the source package manifest in :ref:`package-explorer`.
 
-- File icon indicates that the detection belongs to a plain file, you can click on it to view the file in :ref:`table-view`.
+- File icon indicates that the detection belongs to a plain file,
+  you can click on it to view the file in :ref:`table-view`.
 
 .. figure:: data/license-explorer-fileregion.gif
 

docs/source/how-to-guides/explore-your-data/navigate-package-explorer.rst

@@ -37,7 +37,7 @@ dependency flags by selecting filter values in the top-left
 
 .. figure:: data/package-explorer-filter.gif
 
-Dependencies table
+Dependencies
 ========================
 
 When a package is selected, the dependencies for that package are shown

docs/source/ui-reference/license-explorer.rst

@@ -101,7 +101,8 @@ Similarly, detection origin is a clickable icon. It determines the source of det
 - Package icon indicates that the detection belongs to a package manifest,
   you can click on it to view the source package manifest in :ref:`package-explorer`.
 
-- File icon indicates that the detection belongs to a plain file, you can click on it to view the file in :ref:`table-view`.
+- File icon indicates that the detection belongs to a plain file,
+  you can click on it to view the file in :ref:`table-view`.
 
 .. figure:: data/license-explorer/license-explorer-fileregion.gif
 

docs/source/ui-reference/pie-charts.rst

@@ -39,7 +39,7 @@ You can click on the legend items to toggle the visibility of corresponding pie
 .. figure:: data/pie-charts/pie-charts-legend-toggle.gif
    :align: center
    :width: 100%
-   
+
    Click legend item to toggle segment visibility in Pie chart
 
 .. include:: ../rst_snippets/scans-used.rst