Skip to content

Commit 3d39090

Browse files
Add fixes
Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>
1 parent 8745ca0 commit 3d39090

4 files changed

Lines changed: 53 additions & 53 deletions

File tree

docs/source/cli-reference/synopsis.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ Installation
1919
------------
2020

2121
Scancode-Toolkit installation can be done by downloading ScanCode as an application, which
22-
is recommended generally. For users familiar with ``pip``, ScanCode is also available and can be
23-
installed from ``pip``, the default Python Package Manager. Refer the following sections for
22+
is recommended generally. For users who wish to use ScanCode as a library, it can be
23+
installed via ``pip``, the default Python Package Manager. Refer the following sections for
2424
detailed Instructions on the each of the Installation Methods.
2525

2626
- :ref:`app_install`

docs/source/getting-started/install.rst

Lines changed: 40 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -5,21 +5,20 @@ There are 3 main ways you can install ScanCode.
55

66
- :ref:`app_install`
77

8-
The recommended method for installing ScanCode is Downloading the latest release, as an
8+
The recommended method for installing ScanCode is Downloading the latest release as an
99
application and then configure and use directly. This is easy because no knowledge of pip/git
1010
or other developer tools is necessary.
1111

12-
- :ref:`pip_install`
13-
14-
The fastest way to install ScanCode as a python package, using ``pip``. You can also install
15-
ScanCode by compiling it from source or by Downloading and Configuring the
16-
latest release from GitHub.
17-
1812
- :ref:`source_code_install`
1913

2014
You can download/clone the source code repository via git/GitHub and then run a configure script
2115
to install ScanCode.
2216

17+
- :ref:`pip_install`
18+
19+
To use ScanCode as a library in your application, you can install it via ``pip``. This is
20+
recommended for developers/users familiar with Package managers/virtualenv.
21+
2322
----
2423

2524
Before Installing
@@ -50,7 +49,7 @@ ScanCode needs a Python 3.6 (*highly recommended*) or a Python 2.7 interpreter.
5049

5150
.. Note::
5251

53-
ScanCode currently doesn't support Python 3.7.x or 3.8.x, though support will be added soon.
52+
ScanCode currently doesn't support versions above Python 3.6.x, though support will be added soon.
5453

5554
- **On Linux**:
5655

@@ -235,39 +234,6 @@ Un-installation
235234

236235
----
237236

238-
.. _pip_install:
239-
240-
Installation as a library: via ``pip``
241-
--------------------------------------
242-
243-
ScanCode can be easily installed using ``pip``. The steps are:
244-
245-
#. Create a Python 3.6 Virtual Environment::
246-
247-
virtualenv -p /usr/bin/python3.6 venv-scancode
248-
249-
For more information on Python virtualenv, visit this `page <https://docs.python-guide.org/dev/virtualenvs/#lower-level-virtualenv>`_.
250-
251-
#. Activate the Virtual Environment you just created::
252-
253-
source venv-scancode/bin/activate
254-
255-
#. Run ``pip install scancode-toolkit`` to install the latest version of Scancode.
256-
257-
.. NOTE::
258-
259-
If you use Python 2.7, scancode-toolkit Version 3.0.2 is installed by default. For Python 3
260-
the latest version of Scancode Toolkit is installed by default. Requesting a specific version
261-
through ``pip install`` for Python 3 will give Errors if the Version isn't 3.1.x or later.
262-
263-
.. WARNING::
264-
265-
Python 3.7.x and 3.8.x is not supported yet.
266-
267-
To uninstall, run ``pip uninstall scancode-toolkit``.
268-
269-
----
270-
271237
.. _source_code_install:
272238

273239
Installation from Source Code: Git Clone
@@ -327,6 +293,39 @@ Now you are ready to use the freshly configured scancode-toolkit.
327293

328294
----
329295

296+
.. _pip_install:
297+
298+
Installation as a library: via ``pip``
299+
--------------------------------------
300+
301+
ScanCode can be installed using ``pip``, the default Python Package Manager. The steps are:
302+
303+
#. Create a Python 3.6 Virtual Environment::
304+
305+
virtualenv -p /usr/bin/python3.6 venv-scancode
306+
307+
For more information on Python virtualenv, visit this `page <https://docs.python-guide.org/dev/virtualenvs/#lower-level-virtualenv>`_.
308+
309+
#. Activate the Virtual Environment you just created::
310+
311+
source venv-scancode/bin/activate
312+
313+
#. Run ``pip install scancode-toolkit`` to install the latest version of Scancode.
314+
315+
.. NOTE::
316+
317+
If you use Python 2.7, scancode-toolkit Version 3.0.2 is installed by default. For Python 3
318+
the latest version of Scancode Toolkit is installed by default. Requesting a specific version
319+
through ``pip install`` for Python 3 will give Errors if the Version isn't 3.1.x or later.
320+
321+
.. WARNING::
322+
323+
Python 3.7.x and 3.8.x is not supported yet.
324+
325+
To uninstall, run ``pip uninstall scancode-toolkit``.
326+
327+
----
328+
330329
.. _commands_variation:
331330

332331
Commands Variation

docs/source/getting-started/newcomer.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Table of Contents
1616
- :ref:`newcomer_before`
1717
- :ref:`newcomer_install`
1818
- :ref:`newcomer_scan_codebase`
19-
- :ref:`newcomer_use_scancode_better`
19+
- :ref:`newcomer_scancode_tips`
2020
- :ref:`newcomer_all_tutorials`
2121
- :ref:`newcomer_whats_new`
2222

@@ -48,7 +48,7 @@ determine their license, copyrights and other information, according to your req
4848
#. The :ref:`newcomer_scan_codebase` section helps you with configuring your virtual environment,
4949
installing Scancode and performing a basic scan, and subsequently visualize the results.
5050

51-
#. The :ref:`newcomer_use_scancode_better` section helps you customize the scan according to your
51+
#. The :ref:`newcomer_scancode_tips` section helps you customize the scan according to your
5252
requirements, and better understand the advanced features you can use.
5353

5454
#. The :ref:`newcomer_all_tutorials` is essentially an exhaustive list of all Tutorials and How To's
@@ -66,11 +66,11 @@ Scancode-Toolkit can be installed in 3 different methods.
6666
#. The :ref:`newcomer_scan_codebase` section helps you with configuring your virtual environment,
6767
installing Scancode and performing a basic scan, and subsequently visualize the results.
6868

69-
#. The :ref:`newcomer_use_scancode_better` section helps you customize the scan according to your
69+
#. The :ref:`newcomer_scancode_tips` section helps you customize the scan according to your
7070
requirements, and better understand the advanced features you can use.
7171

72-
#. The :ref:`newcomer_all_tutorials` is essentially an exhaustive list of all Tutorials and How To's
73-
with a brief descrip
72+
#. The :ref:`newcomer_all_tutorials` is essentially an exhaustive list of all Tutorials and
73+
How To's with a brief description.
7474

7575

7676
.. _newcomer_before:
@@ -120,7 +120,7 @@ Once you are all set up with Scancode Toolkit, i.e. Running ``scancode -h`` show
120120
`Scancode Workbench <https://github.com/nexB/scancode-workbench>`_. Follow this tutorial :ref:`how_to_visualize_scan_results`
121121
to visualize the scan results.
122122

123-
.. _newcomer_use_scancode_better:
123+
.. _newcomer_scancode_tips:
124124

125125
Use ScanCode Better
126126
^^^^^^^^^^^^^^^^^^^

docs/source/getting-started/whats-new.rst

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,8 @@ other languages. And as Scancode has users in more than 100 languages, this is a
6666
Better install Support
6767
^^^^^^^^^^^^^^^^^^^^^^^
6868

69-
Now, Downloading ScanCode as an Application is the recommended install method, across all platforms.
70-
This greatly simplifies the install process, and is much easier for all users. Developers familiar with
71-
package managers can also download ScanCode as a library, via ``pip`` or configure from the source. All
72-
these methods are properly documented, across all platforms and scenarios.
69+
Now, Downloading ScanCode as an Application is the recommended install method, across all
70+
platforms. This greatly simplifies the install process, and is much easier for all users.
71+
Developers familiar with package managers can also download ScanCode as a library, via ``pip``
72+
or configure from the source. All these methods are properly documented, across all platforms
73+
and scenarios.

0 commit comments

Comments
 (0)