Skip to content

Commit 8dfe650

Browse files
Fix documentation updates
Signed-off-by: Ayan Sinha Mahapatra <[email protected]>
1 parent 25120fd commit 8dfe650

File tree

3 files changed

+30
-25
lines changed

3 files changed

+30
-25
lines changed

docs/source/cli-reference/synopsis.rst

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,15 @@ Toolkit Command Line Interface in the following sections:
1818
Installation
1919
------------
2020

21-
See the following for the installation guide:
21+
Scancode-Toolkit installation can be done by downloading ScanCode as an application, which
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
24+
detailed Instructions on the each of the Installation Methods.
25+
26+
- :ref:`app_install`
27+
- :ref:`pip_install`
28+
- :ref:`source_code_install`
2229

23-
- :ref:`newcomer_install`
2430

2531
.. _synopsis_quickstart:
2632

docs/source/getting-started/newcomer.rst

Lines changed: 5 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ Table of Contents
1414
#. :ref:`newcomer_try_scancode`
1515

1616
- :ref:`newcomer_before`
17-
- :ref:`newcomer_install`
1817
- :ref:`newcomer_scan_codebase`
1918
- :ref:`newcomer_scancode_tips`
2019
- :ref:`newcomer_all_tutorials`
@@ -54,26 +53,18 @@ determine their license, copyrights and other information, according to your req
5453
#. The :ref:`newcomer_all_tutorials` is essentially an exhaustive list of all Tutorials and How To's
5554
with a brief description on what they help you to achieve.
5655

57-
.. _newcomer_install:
58-
59-
Installing ScanCode
60-
-------------------
61-
62-
ScanCode-Toolkit can be installed in 3 different methods.
63-
64-
6556
.. _newcomer_before:
6657

6758
Before you start using ScanCode
6859
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
6960

7061
#. You need to make sure :ref:`install_prerequisites` are installed, and a `virtualenv <https://docs.python-guide.org/dev/virtualenvs/>`_
71-
is created.
62+
is created. There are a few different ways to install ScanCode:
7263

73-
:ref:`app_install`
74-
:ref:`docker_install`
75-
:ref:`pip_install`
76-
:ref:`source_code_install`
64+
- :ref:`app_install` [Recommended for newcomers]
65+
- :ref:`docker_install`
66+
- :ref:`pip_install`
67+
- :ref:`source_code_install`
7768

7869

7970
#. Run ``scancode -h`` to make sure ScanCode was installed properly.

docs/source/reference/available_package_parsers.rst

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
Supported package manifests and package datafiles
66
-------------------------------------------------
77

8-
ScanCode supports a wide variety of package manifests, lockfiles
8+
Scancode supports a wide variety of package manifests, lockfiles
99
and other package datafiles containing package and dependency
1010
information.
1111

@@ -224,13 +224,29 @@ parsers in scancode-toolkit during documentation builds.
224224
- ``conan_conanfile_py``
225225
- C++
226226
- https://docs.conan.io/2.0/reference/conanfile.html
227+
* - Conda metadata JSON in rootfs
228+
- ``*conda-meta/*.json``
229+
- ``conda``
230+
- ``linux``, ``win``, ``mac``
231+
- ``conda_meta_json``
232+
- Python
233+
- https://docs.conda.io/
227234
* - Conda meta.yml manifest
228235
- ``*/meta.yaml``
229236
- ``conda``
230237
- ``linux``, ``win``, ``mac``
231238
- ``conda_meta_yaml``
232239
- None
233240
- https://docs.conda.io/
241+
* - Conda yaml manifest
242+
- ``*conda*.yaml``
243+
``*env*.yaml``
244+
``*environment*.yaml``
245+
- ``conda``
246+
- ``linux``, ``win``, ``mac``
247+
- ``conda_yaml``
248+
- Python
249+
- https://docs.conda.io/
234250
* - CPAN Perl dist.ini
235251
- ``*/dist.ini``
236252
- ``cpan``
@@ -728,14 +744,6 @@ parsers in scancode-toolkit during documentation builds.
728744
- ``pubspec_yaml``
729745
- dart
730746
- https://dart.dev/tools/pub/pubspec
731-
* - Conda yaml manifest
732-
- ``*conda.yaml``
733-
``*conda.yml``
734-
- ``pypi``
735-
- ``linux``, ``win``, ``mac``
736-
- ``conda_yaml``
737-
- Python
738-
- https://docs.conda.io/
739747
* - pip requirements file
740748
- ``*requirement*.txt``
741749
``*requirement*.pip``

0 commit comments

Comments
 (0)