Fix pip and python 3 support

This commit adds support for pip install and Python 3 install methods. Also standardizes scan commands
across the docs.

Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>

Author: AyanSinhaMahapatra

docs/source/scancode-toolkit/cli-reference/basic-options.rst

@@ -5,14 +5,18 @@
 
 ----
 
+.. include::  /scancode-toolkit/rst_snippets/note_snippets/synopsis_install_quickstart.rst
+
+----
+
 ``--generated`` Options
 -----------------------
 
     The ``--generated`` option classifies automatically generated code files with a flag.
 
     An example of using ``--generated`` in a scan::
 
-        ./scancode -clpieu --json-pp output.json samples --generated
+        scancode -clpieu --json-pp output.json samples --generated
 
     In the results, for each file the following attribute is added with it's corresponding
     ``true``/``false`` value ::
@@ -47,7 +51,7 @@
 
     An example usage::
 
-        ./scancode -clpieu --json-pp output.json samples --max-email 5
+        scancode -clpieu --json-pp output.json samples --max-email 5
 
     This only reports 5 email addresses per file and ignores the rest.
 
@@ -71,7 +75,7 @@
 
     An example usage::
 
-        ./scancode -clpieu --json-pp output.json samples --max-url 10
+        scancode -clpieu --json-pp output.json samples --max-url 10
 
     This only reports 10 urls per file and ignores the rest.
 
@@ -100,7 +104,7 @@
 
     An example usage::
 
-        ./scancode -clpieu --json-pp output.json samples --license-score 70
+        scancode -clpieu --json-pp output.json samples --license-score 70
 
     Here's the license results on setting the integer value to 100, Vs. the default value 0. This is
     visualized using ScanCode workbench in the License Info Dashboard.
@@ -134,7 +138,7 @@
 
     An example Scan::
 
-        ./scancode -cplieu --json-pp output.json samples --license-text
+        scancode -cplieu --json-pp output.json samples --license-text
 
     An example matched text included in the results is as follows::
 
@@ -178,7 +182,7 @@
 
     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/{}.yml
 
     In a normal scan, reference url for "ZLIB License" is as follows::
 
@@ -212,7 +216,7 @@
 
     An example Scan::
 
-        ./scancode -cplieu --json-pp output.json samples --license-text --license-text-diagnostics
+        scancode -cplieu --json-pp output.json samples --license-text --license-text-diagnostics
 
     Running a scan on the samples directory with ``--license-text --license-text-diagnostics`` options,
     causes the following difference in the scan result of the file

docs/source/scancode-toolkit/cli-reference/core-options.rst

@@ -7,6 +7,10 @@
 
 ----
 
+.. include::  /scancode-toolkit/rst_snippets/note_snippets/synopsis_install_quickstart.rst
+
+----
+
 Comparing Progress Message Options
 ----------------------------------
 
@@ -89,7 +93,7 @@ Comparing Progress Message Options
 
     An example scan command using ``--from-json``::
 
-        ./scancode --from-json sample.json --json-pp sample_2.json --classify
+        scancode --from-json sample.json --json-pp sample_2.json --classify
 
     This inputs the scan results from ``sample.json``, runs the post-scan plugin ``--classify`` and
     outputs the results for this scan to ``sample_2.json``.
@@ -114,4 +118,4 @@ Comparing Progress Message Options
 
     An example usage::
 
-        ./scancode -clieu --json-pp sample.json samples --max-in-memory -1
+        scancode -clieu --json-pp sample.json samples --max-in-memory -1

docs/source/scancode-toolkit/cli-reference/help-text-options.rst

@@ -20,19 +20,11 @@ displays basic usage, and some simple examples. The command line option for this
 
     You can also use the shorter ``-h`` option, which does the same.
 
-For Linux based systems the full command is::
-
-    $ ./scancode --help
-
-And for windows, it will be like::
+To see the help text from the Terminal, execute the following command::
 
     $ scancode --help
 
-.. note::
-
-    Make sure you are in the Scancode Root Directory before carrying out this command. After
-    extracting the ``.zip`` or ``.tar.bz`` file, the folder for Scancode-Toolkit version 3.1.1
-    will be named like "scancode-toolkit-3.1.1".
+.. include::  /scancode-toolkit/rst_snippets/note_snippets/synopsis_install_quickstart.rst
 
 The Following Help Text is displayed, i.e. This is the help text for Scancode Version 3.1.1 ::
 
@@ -235,14 +227,12 @@ of code scanning:
 
 The command line option for displaying these basic examples is ``--examples``.
 
-For Linux based systems the full command is::
-
-    $ ./scancode --examples
-
-And for windows, it will be like::
+To see the help text from the Terminal, execute the following command::
 
     $ scancode --examples
 
+.. include::  /scancode-toolkit/rst_snippets/note_snippets/synopsis_install_quickstart.rst
+
 The Following Text is displayed, i.e. This is the examples for Scancode Version 3.1.1 ::
 
     Scancode command lines examples:
@@ -311,14 +301,12 @@ The command line option for displaying all the plugins is:
 
 - ``--plugins``
 
-For Linux based systems the full command is::
-
-    $ ./scancode --plugins
-
-And for windows, it will be like::
+To see the help text from the Terminal, execute the following command::
 
     $ scancode --plugins
 
+.. include::  /scancode-toolkit/rst_snippets/note_snippets/synopsis_install_quickstart.rst
+
 .. note::
 
     Plugins that are shown by using ``--plugins`` include the following:
@@ -772,7 +760,7 @@ This option prints the options selected for one specific scan command.
 
 If we run this command::
 
-    ./scancode -clpieu --json-pp sample.json samples --classify --summary --summary-with-details --print-options
+    scancode -clpieu --json-pp sample.json samples --classify --summary --summary-with-details --print-options
 
 The output will be::
 

docs/source/scancode-toolkit/cli-reference/list-options.rst

@@ -18,6 +18,8 @@ There's also another section for ``extractcode`` options.
 The order of the sections and all their options is the same as in the :ref:'cli_help_text',
 available in the command line.
 
+.. include::  /scancode-toolkit/rst_snippets/note_snippets/synopsis_install_quickstart.rst
+
 .. _cli_basic:
 
 .. include::  /scancode-toolkit/rst_snippets/basic_options.rst

docs/source/scancode-toolkit/cli-reference/output-filters-and-control.rst

@@ -7,6 +7,10 @@ Controlling Scancode Output and Filters
 
 ----
 
+.. include::  /scancode-toolkit/rst_snippets/note_snippets/synopsis_install_quickstart.rst
+
+----
+
 ``--strip-root`` Vs. ``--full-root``
 ------------------------------------
 
@@ -17,7 +21,7 @@ Controlling Scancode Output and Filters
 
     ::
 
-        ./scancode -cplieu --json-pp output.json samples --full-root
+        scancode -cplieu --json-pp output.json samples --full-root
 
     These two changes only the "path" attribute of the file information. For this comparison we
     compare the "path" attributes of the file ``LICENSE`` inside ``JGroups`` directory.
@@ -53,7 +57,7 @@ Controlling Scancode Output and Filters
 
     This scan ignores all files with authors matching the string "Apache Software Foundation"::
 
-        ./scancode -cplieu --json-pp output.json samples --ignore-author "Apache Software Foundation"
+        scancode -cplieu --json-pp output.json samples --ignore-author "Apache Software Foundation"
 
     More information on :ref:`glob_pattern_matching`.
 
@@ -71,7 +75,7 @@ Controlling Scancode Output and Filters
 
     This scan ignores all files with Copyright Holders matching the string "Free Software Foundation"::
 
-        ./scancode -cplieu --json-pp output.json samples --ignore-copyright-holder "Free Software Foundation"
+        scancode -cplieu --json-pp output.json samples --ignore-copyright-holder "Free Software Foundation"
 
     More information on :ref:`glob_pattern_matching`.
 
@@ -86,7 +90,7 @@ Controlling Scancode Output and Filters
 
     An example Scan::
 
-        ./scancode -cplieu --json-pp output.json samples --only-findings
+        scancode -cplieu --json-pp output.json samples --only-findings
 
     .. note::
 

docs/source/scancode-toolkit/cli-reference/output-format.rst

@@ -12,6 +12,10 @@ following options.
 
 ----
 
+.. include::  /scancode-toolkit/rst_snippets/note_snippets/synopsis_install_quickstart.rst
+
+----
+
 .. _output_to_stdout:
 
 .. include::  /scancode-toolkit/rst_snippets/stdout.rst
@@ -30,7 +34,7 @@ following options.
     The following code performs a scan on the samples directory, and publishes the results in
     ``json`` format::
 
-        ./scancode -clpieu --json output.json samples
+        scancode -clpieu --json output.json samples
 
     .. include::  /scancode-toolkit/rst_snippets/note_snippets/output_json_ugly.rst
 
@@ -144,7 +148,7 @@ following options.
     The following code performs a scan on the samples directory, and publishes the results in
     ``json-pp`` format::
 
-        ./scancode -clpieu --json-pp output.json samples
+        scancode -clpieu --json-pp output.json samples
 
     A sample JSON output for an individual file will look like::
 
@@ -247,7 +251,7 @@ following options.
     The following code performs a scan on the samples directory, and publishes the results in
     ``json-lines`` format::
 
-        ./scancode -clpieu --json-lines output.json samples
+        scancode -clpieu --json-lines output.json samples
 
     Here is a sample line from a report generated by the ``jsonlines`` format::
 
@@ -342,7 +346,7 @@ Comparing Different ``json`` Output Formats
     The following code performs a scan on the samples directory, and publishes the results in
     ``spdx-rdf`` format::
 
-        ./scancode -clpieu --spdx-rdf output.spdx samples
+        scancode -clpieu --spdx-rdf output.spdx samples
 
     Learn more about SPDX specifications `here <https://spdx.org/specifications>`_ and in this GitHub
     `repository <https://github.com/spdx/spdx-spec>`_.
@@ -363,7 +367,7 @@ Comparing Different ``json`` Output Formats
     The following code performs a scan on the samples directory, and publishes the results in
     ``spdx-tv`` format::
 
-        ./scancode -clpieu --spdx-tv output.spdx samples
+        scancode -clpieu --spdx-tv output.spdx samples
 
     A SPDX-TV file starts with::
 
@@ -431,7 +435,7 @@ Comparing Different ``json`` Output Formats
     The following code performs a scan on the samples directory, and publishes the results in
     HTML format::
 
-        ./scancode -clpieu --html output.html samples
+        scancode -clpieu --html output.html samples
 
     The HTML page generated has these following Tables:
 
@@ -457,10 +461,12 @@ Comparing Different ``json`` Output Formats
     ScanCode also supports formatting the output in a HTML visualization tool, which is more
     helpful than the standard HTML format.
 
+    .. include::  /scancode-toolkit/rst_snippets/warning_snippets/output_htmlapp_dep.rst
+
     The following code performs a scan on the samples directory, and publishes the results in
     ``html-app`` format::
 
-        ./scancode -clpieu --csv output.html samples
+        scancode -clpieu --csv output.html samples
 
     The Files scanned are shown in the left sidebar, and the section on the right contains separate
     tabs for the following:
@@ -476,8 +482,6 @@ Comparing Different ``json`` Output Formats
 
     .. include::  /scancode-toolkit/rst_snippets/note_snippets/output_htmlapp_search.rst
 
-    .. include::  /scancode-toolkit/rst_snippets/warning_snippets/output_htmlapp_dep.rst
-
     .. figure:: data/output_html_app1.png
 
     .. figure:: data/output_html_app2.png
@@ -494,7 +498,7 @@ Comparing Different ``json`` Output Formats
     The following code performs a scan on the samples directory, and publishes the results in
     ``csv`` format::
 
-        ./scancode -lpceiu --csv sample.csv samples
+        scancode -lpceiu --csv sample.csv samples
 
     The first line of the csv file contains the headings, and they are: