Skip to content

Commit 154ab04

Browse files
Adds links to Documentaion
Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>
1 parent 4f0e478 commit 154ab04

7 files changed

Lines changed: 15 additions & 15 deletions

File tree

docs/source/scancode-toolkit/developement.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Another useful option after a test run with some failures is to re-run only the
5050
pip requirements and the configure script
5151
-----------------------------------------
5252

53-
ScanCode use the ``configure`` and ``configure.bat`` (and ``etc/configure.py`` behind the scenes) scripts to install a virtualenv, install required packaged dependencies as pip requirements and more configure tasks such that ScanCode can be installed in a self-contained way with no network connectivity required.
53+
ScanCode use the ``configure`` and ``configure.bat`` (and ``etc/configure.py`` behind the scenes) scripts to install a `virtualenv <https://virtualenv.pypa.io/en/stable/>`_ , install required packaged dependencies as `pip <https://github.com/pypa/pip>`_ requirements and more configure tasks such that ScanCode can be installed in a self-contained way with no network connectivity required.
5454

5555
Earlier unreleased versions of ScanCode where using ``buildout`` to install and configure eventually complex dependencies. We had some improvements that were merged in the upstream ``buildout`` to support bootstrapping and installing without a network connection and When we migrated to use ``pip`` and ``wheels`` as new, improved and faster way to install and configure dependencies we missed some of the features of ``buildout`` like the ``recipes``, being able to invoke arbitrary Python or shell scripts after installing packages and have scripts or requirements that are operating system-specific.
5656

docs/source/scancode-toolkit/documentation.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This page provides an index of current ScanCode user documentation.
66
Download
77
--------
88

9-
Download the latest release of ScanCode from our release page.
9+
Download the latest release of ScanCode from our `release page <https://github.com/nexB/scancode-toolkit/releases.>`_
1010

1111
Installation
1212
------------

docs/source/scancode-toolkit/home.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Scancode-Toolkit
2-
================
1+
Home
2+
====
33

44
ScanCode is a tool to scan code and detect licenses, copyrights and more
55

docs/source/scancode-toolkit/ide_configaration.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
IDE Configuration
22
=================
33

4-
The instructions below assume that you followed the steps to set up a development environment including a python virtualenv.
4+
The instructions below assume that you followed the `steps to set up a development environment <https://github.com/nexB/scancode-toolkit/wiki/FAQ#how-to-get-started-with-development>`_ including a python virtualenv.
55

66
PyCharm
77
-------
@@ -11,7 +11,7 @@ Open the settings dialog and navigate to "Project Interpreter". Click on the gea
1111
Visual Studio Code
1212
------------------
1313

14-
Install the Python extension from Microsoft.
14+
Install the `Python extension from Microsoft <https://marketplace.visualstudio.com/items?itemName=ms-python.python>`_.
1515

1616
The ``configure`` script should have created a VSCode workspace directory with a basic ``settings.json``. To do this manually, add to or create the workspace settings file ``.vscode/settings.json``::
1717

docs/source/scancode-workbench/building.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,21 +5,21 @@ Linux
55
-----
66

77
- Python 2.7
8-
- Node.js 6.x or later
8+
- `Node.js <https://nodejs.org/en/>`_ 6.x or later
99
- npm 3.10.x or later but <= 5.2.0 (run ``npm install npm@5.2.0 -g``)
1010

1111
MacOS
1212
-----
1313

1414
- Python 2.7
15-
- Node.js >=6.x or later but <=8.9.4
15+
- `Node.js <https://nodejs.org/en/>`_ >=6.x or later but <=8.9.4
1616
- npm 3.10.x or later but <= 5.2.0 (run ``npm install npm@5.2.0 -g``)
17-
- Command Line Tools for Xcode (run ``xcode-select --install to install``)
17+
- Command Line Tools for `Xcode <https://developer.apple.com/xcode/downloads/>`_ (run ``xcode-select --install to install``)
1818

1919
Windows
2020
-------
2121

22-
- Node.js 6.x or later
22+
- `Node.js <https://nodejs.org/en/>`_ 6.x or later
2323
- npm 3.10.x or later but <= 5.2.0 (``run npm install npm@5.2.0 -g``)
2424
- Python v2.7.x
2525

@@ -29,8 +29,8 @@ Windows
2929

3030
* Either:
3131

32-
- Option 1: Install Visual C++ Build Tools 2015 (or modify an existing installation) and select Common Tools for Visual C++ during setup. This also works with the free Community and Express for Desktop editions.
33-
- Option 2: Install Visual Studio 2015 (Community Edition or better)
32+
- Option 1: Install `Visual C++ Build Tools 2015 <https://www.microsoft.com/en-in/download/details.aspx?id=48159>`_ (or modify an existing installation) and select Common Tools for Visual C++ during setup. This also works with the free Community and Express for Desktop editions.
33+
- Option 2: `Visual Studio 2015 <https://visualstudio.microsoft.com/vs/older-downloads/>`_ (Community Edition or better)
3434

35-
* Note: Windows 7 requires .NET Framework 4.5.1
35+
* Note: Windows 7 requires `.NET Framework 4.5.1 <http://www.microsoft.com/en-us/download/details.aspx?id=40773>`_
3636
* Launch cmd, ``npm config set msvs_version 2015``

docs/source/scancode-workbench/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
ScanCode Workbench allows you take the scan results from the ScanCode Toolkit and create a software inventory annotated with your summaries or conclusions (we call these Conclusions) at any levels of the codebase you choose.
55

6-
The attributes you add (e.g., Name, Version, Owner, License Expression, Copyright) to your Conclusion about a single package or file -- or a higher-level group of packages and/or files -- can then be exported to a JSON or SQLite file. In addition, Conclusions created in ScanCode Workbench can be exported to DejaCode.
6+
The attributes you add (e.g., Name, Version, Owner, License Expression, Copyright) to your Conclusion about a single package or file -- or a higher-level group of packages and/or files -- can then be exported to a JSON or SQLite file. In addition, Conclusions created in ScanCode Workbench can be exported to `DejaCode <https://enterprise.dejacode.com/licenses/>`_.
77

88
.. toctree::
99
:maxdepth: 3

docs/source/scancode-workbench/scancode_workbench_views.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ An interactive directory tree is always present on the left side of the applicat
1111
Table View
1212
----------
1313

14-
In the table view, the available clues detected by ScanCode are shown in a tabular format. A user can see provenance clues such as license and copyright information detected by ScanCode. A user can also see the file information (e.g. file type, file size, etc) and package information (package type, primary language of package) that was detected. The columns can be sorted as well as shown or hidden based on what the user’s preferences. Searching for specific clues (license names, copyrights, etc.) is also available in this view.
14+
In the table view, the available clues detected by `ScanCode <https://github.com/nexB/scancode-toolkit/>`_ are shown in a tabular format. A user can see provenance clues such as license and copyright information detected by ScanCode. A user can also see the file information (e.g. file type, file size, etc) and package information (package type, primary language of package) that was detected. The columns can be sorted as well as shown or hidden based on what the user’s preferences. Searching for specific clues (license names, copyrights, etc.) is also available in this view.
1515

1616
.. image:: table-view.gif
1717

0 commit comments

Comments
 (0)