Add "Scan Package" pipeline in the documentation along some cleanups

tdruez · tdruez · commit 15fe08decee6 · 2021-07-20T10:34:57.000+04:00
Signed-off-by: Thomas Druez &lt;tdruez@nexb.com&gt;
diff --git a/docs/run-docker.rst b/docs/run-docker.rst
@@ -27,8 +27,8 @@ create an environment file, and build the Docker image::
     docker-compose build
 
 .. note::
-    The image will need to be re-build when the ScanCode.io app source code if
-    modified or updated.
+    The image will need to be re-build when the ScanCode.io source code is modified or
+    updated.
 
 Run the Image
 -------------
diff --git a/docs/scanpipe-output.rst b/docs/scanpipe-output.rst
@@ -1,7 +1,7 @@
 .. _scanpipe_output:
 
-Output
-======
+Output Files
+============
 
 Whether you use the command line or the web application to run your
 scans, the generated results are available for review or export in
diff --git a/docs/scanpipe-pipelines.rst b/docs/scanpipe-pipelines.rst
@@ -27,3 +27,8 @@ Scan Codebase
 -------------
 .. autoclass:: scanpipe.pipelines.scan_codebase.ScanCodebase()
     :members:
+
+Scan Package
+------------
+.. autoclass:: scanpipe.pipelines.scan_package.ScanPackage()
+    :members:
diff --git a/docs/tutorial-1.rst b/docs/tutorial-1.rst
@@ -1,7 +1,7 @@
 .. _tutorial_1:
 
-Docker Image Analysis (command line)
-====================================
+Analyze Docker Image (command line)
+===================================
 
 In this tutorial, you will learn by example how to use ScanCode.io to analyze
 a test Docker image by following the given steps and, along the way,
diff --git a/docs/tutorial-2.rst b/docs/tutorial-2.rst
@@ -1,7 +1,8 @@
 .. _tutorial_2:
 
-Scan Codebase (command line)
-============================
+Analyze Codebase (command line)
+===============================
+
 The focus of this tutorial is to guide you through scanning a codebase package
 using ScanCode.io.
 
