Merge remote-tracking branch 'skeleton/main' into fix-doc-builds

Signed-off-by: Ayan Sinha Mahapatra <[email protected]>

Author: AyanSinhaMahapatra

configure

@@ -30,6 +30,7 @@ CLI_ARGS=$1
 # Requirement arguments passed to pip and used by default or with --dev.
 REQUIREMENTS="--editable . --constraint requirements.txt"
 DEV_REQUIREMENTS="--editable .[testing,packages] --constraint requirements.txt --constraint requirements-dev.txt"
+DOCS_REQUIREMENTS="--editable .[docs] --constraint requirements.txt"
 
 # where we create a virtualenv
 VIRTUALENV_DIR=venv
@@ -178,6 +179,7 @@ while getopts :-: optchar; do
                 help  ) cli_help;;
                 clean ) find_python && clean;;
                 dev   ) CFG_REQUIREMENTS="$DEV_REQUIREMENTS";;
+                docs   ) CFG_REQUIREMENTS="$DOCS_REQUIREMENTS";;
             esac;;
     esac
 done

configure.bat

@@ -28,6 +28,7 @@
 @rem # Requirement arguments passed to pip and used by default or with --dev.
 set "REQUIREMENTS=--editable . --constraint requirements.txt"
 set "DEV_REQUIREMENTS=--editable .[testing] --constraint requirements.txt --constraint requirements-dev.txt"
+set "DOCS_REQUIREMENTS=--editable .[docs] --constraint requirements.txt"
 
 @rem # where we create a virtualenv
 set "VIRTUALENV_DIR=venv"
@@ -78,6 +79,9 @@ if not "%1" == "" (
     if "%1" EQU "--dev"    (
         set "CFG_REQUIREMENTS=%DEV_REQUIREMENTS%"
     )
+    if "%1" EQU "--docs"    (
+        set "CFG_REQUIREMENTS=%DOCS_REQUIREMENTS%"
+    )
     shift
     goto again
 )

docs/source/contribute/contrib_doc.rst

@@ -18,23 +18,23 @@ That will create an ``/scancode-toolkit`` directory in your working directory.
 Now you can install the dependencies in a virtualenv::
 
     cd scancode-toolkit
-    ./configure --dev
-    source venv/bin/activate
+    ./configure --docs
+
+.. note::
+
+    In case of windows, run ``configure --docs`` instead of this.
 
-Now, the following prerequisites should be installed
+Now, this will install the following prerequisites:
 
 - Sphinx
 - sphinx_rtd_theme (the format theme used by ReadTheDocs)
 - docs8 (style linter)
 
-::
-
-    pip install -e .[docs]
-
-These requirements are already present in setup.cfg and this installs them.
+These requirements are already present in setup.cfg and `./configure --docs` installs them.
 
 Now you can build the HTML documents locally::
 
+    source venv/bin/activate
     cd docs
     make html
 
@@ -116,9 +116,10 @@ Style Checks Using ``Doc8``
 How To Run Style Tests
 ^^^^^^^^^^^^^^^^^^^^^^
 
-In the project root, run the following command::
+In the project root, run the following commands::
 
-    $ doc8 --max-line-length 100 docs/source/ --ignore D000
+    $ cd docs
+    $ ./scripts/doc8_style_check.sh
 
 A sample output is::