Skip to content

Docs: fix outdated ScanCode output format references #4648

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Vijya2024 wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Docs: fix outdated ScanCode output format references #4648

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 27 additions & 27 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,40 +97,40 @@ Why use ScanCode?
and a few more. See `all available package parsers <https://scancode-toolkit.readthedocs.io/en/stable/reference/available_package_parsers.html>`_
for the exhaustive list.

See our `roadmap <https://scancode-toolkit.readthedocs.io/en/latest/contribute/roadmap.html>`_
See our `roadmap <https://scancode-toolkit.readthedocs.io/en/stable/contribute/roadmap.html>`_
for upcoming features.


Documentation
=============

The ScanCode documentation is hosted at
`scancode-toolkit.readthedocs.io <https://scancode-toolkit.readthedocs.io/en/latest/>`_.
`scancode-toolkit.readthedocs.io <https://scancode-toolkit.readthedocs.io/en/stable/>`_.

If you are new to visualization of scancode results data, start with our
`newcomer <https://scancode-toolkit.readthedocs.io/en/latest/getting-started/newcomer.html>`_ page.
`newcomer <https://scancode-toolkit.readthedocs.io/en/stable/getting-started/newcomer.html>`_ page.

If you want to compare output changes between different versions of ScanCode,
or want to look at scans generated by ScanCode, review our
`reference scans <https://github.com/nexB/scancode-toolkit-reference-scans>`_.

Other Important Documentation Pages:

- A `synopsis <https://scancode-toolkit.readthedocs.io/en/latest/cli-reference/synopsis.html>`_
- A `synopsis <https://scancode-toolkit.readthedocs.io/en/stable/cli-reference/synopsis.html>`_
of ScanCode command line options.

- Tutorials on:

- `How to run a scan <https://scancode-toolkit.readthedocs.io/en/latest/tutorials/how_to_run_a_scan.html>`_
- `How to visualize scan results <https://scancode-toolkit.readthedocs.io/en/latest/tutorials/how_to_visualize_scan_results.html>`_
- `How to run a scan <https://scancode-toolkit.readthedocs.io/en/stable/tutorials/how_to_run_a_scan.html>`_
- `How to visualize scan results <https://scancode-toolkit.readthedocs.io/en/stable/tutorials/how_to_visualize_scan_results.html>`_

- An exhaustive list of `all available options <https://scancode-toolkit.readthedocs.io/en/latest/cli-reference/list-options.html>`_
- An exhaustive list of `all available options <https://scancode-toolkit.readthedocs.io/en/stable/cli-reference/list-options.html>`_

- Documentation on `Contributing to Code Development <https://scancode-toolkit.readthedocs.io/en/latest/contribute/contrib_dev.html>`_
- Documentation on `Contributing to Code Development <https://scancode-toolkit.readthedocs.io/en/stable/contribute/contrib_dev.html>`_

- Documentation on `Plugin Architecture <https://scancode-toolkit.readthedocs.io/en/latest/plugins/plugin-architecture.html>`_
- Documentation on `Plugin Architecture <https://scancode-toolkit.readthedocs.io/en/stable/plugins/plugin-architecture.html>`_

- `FAQ <https://scancode-toolkit.readthedocs.io/en/latest/misc/faq.html>`_
- `FAQ <https://scancode-toolkit.readthedocs.io/en/stable/misc/faq.html>`_

See also https://aboutcode.org for related companion projects and tools.

Expand All @@ -142,24 +142,24 @@ Before installing ScanCode make sure that you have installed the prerequisites
properly. This means installing Python 3.13 for x86/64 architectures.
We support Python 3.10, 3.11, 3.12 and 3.13.

See `prerequisites <https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html#prerequisites>`_
See `prerequisites <https://scancode-toolkit.readthedocs.io/en/stable/getting-started/install.html#prerequisites>`_
for detailed information on the support platforms and Python versions.

There are a few common ways to `install ScanCode <https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html>`_.
There are a few common ways to `install ScanCode <https://scancode-toolkit.readthedocs.io/en/stable/getting-started/install.html>`_.

- `**Installation as an application: Install Python 3.13, download a release archive, extract and run**.
<https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html#installation-as-an-application-downloading-releases>`_
<https://scancode-toolkit.readthedocs.io/en/stable/getting-started/install.html#installation-as-an-application-downloading-releases>`_
This is the recommended installation method.

- `Development installation from source code using a git clone
<https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html#installation-from-source-code-git-clone>`_
<https://scancode-toolkit.readthedocs.io/en/stable/getting-started/install.html#installation-from-source-code-git-clone>`_

- `Development installation as a library with "pip install scancode-toolkit"
<https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html#pip-install>`_
<https://scancode-toolkit.readthedocs.io/en/stable/getting-started/install.html#pip-install>`_
[Note that this is not supported on arm64 machines]

- `Run in a Docker container with a git clone and "docker run"
<https://scancode-toolkit.readthedocs.io/en/latest/getting-started/install.html#installation-using-docker>`_
<https://scancode-toolkit.readthedocs.io/en/stable/getting-started/install.html#installation-using-docker>`_

- In Fedora 40+ you can `dnf install scancode-toolkit`

Expand All @@ -171,7 +171,7 @@ After ScanCode is installed successfully you can run an example scan printed on

scancode -clip --json-pp - samples

Follow the `How to Run a Scan <https://scancode-toolkit.readthedocs.io/en/latest/tutorials/how_to_run_a_scan.html>`_
Follow the `How to Run a Scan <https://scancode-toolkit.readthedocs.io/en/stable/tutorials/how_to_run_a_scan.html>`_
tutorial to perform a basic scan on the ``samples`` directory distributed by
default with ScanCode.

Expand All @@ -180,14 +180,14 @@ See more command examples::
scancode --examples

See `How to select what will be detected in a scan
<https://scancode-toolkit.readthedocs.io/en/latest/tutorials/how_to_set_what_will_be_detected_in_a_scan.html>`_
and `How to specify the output format <https://scancode-toolkit.readthedocs.io/en/latest/tutorials/how_to_format_scan_output.html>`_
<https://scancode-toolkit.readthedocs.io/en/stable/tutorials/how_to_set_what_will_be_detected_in_a_scan.html>`_
and `How to specify the output format <https://scancode-toolkit.readthedocs.io/en/stable/tutorials/how_to_format_scan_output.html>`_
for more information.

You can also refer to the `command line options synopsis
<https://scancode-toolkit.readthedocs.io/en/latest/cli-reference/synopsis.html>`_
<https://scancode-toolkit.readthedocs.io/en/stable/cli-reference/synopsis.html>`_
and an exhaustive list of `all available command line options
<https://scancode-toolkit.readthedocs.io/en/latest/cli-reference/list-options.html>`_.
<https://scancode-toolkit.readthedocs.io/en/stable/cli-reference/list-options.html>`_.


Archive extraction
Expand All @@ -202,8 +202,8 @@ directory::

./extractcode mytar.tar.bz2

See `all extractcode options <https://scancode-toolkit.readthedocs.io/en/latest/reference/cli-extractcode.html>`_
and `how to extract archives <https://scancode-toolkit.readthedocs.io/en/latest/tutorials/how_to_extract_archives.html>`_ for details.
See `all extractcode options <https://scancode-toolkit.readthedocs.io/en/stable/reference/cli-extractcode.html>`_
and `how to extract archives <https://scancode-toolkit.readthedocs.io/en/stable/tutorials/how_to_extract_archives.html>`_ for details.


Support
Expand All @@ -217,7 +217,7 @@ For discussions and chats, we have:
* an official Gitter channel for `web-based chats
<https://matrix.to/#/#aboutcode-org_discuss:gitter.im>`_.
Gitter is now accessible through `Element <https://element.io/download>`_
or an `IRC bridge <https://matrix-org.github.io/matrix-appservice-irc/latest/usage.html>`_.
or an `IRC bridge <https://matrix-org.github.io/matrix-appservice-irc/stable/usage.html>`_.
There are other AboutCode project-specific channels available there too.

* The discussion channel for `scancode <https://matrix.to/#/#aboutcode-org_scancode:gitter.im>`_
Expand Down Expand Up @@ -248,11 +248,11 @@ the third-party code used in ScanCode for more details.


.. |azure| image:: https://dev.azure.com/nexB/scancode-toolkit/_apis/build/status/nexB.scancode-toolkit?branchName=develop
:target: https://dev.azure.com/nexB/scancode-toolkit/_build/latest?definitionId=1&branchName=develop
:target: https://dev.azure.com/nexB/scancode-toolkit/_build/stable?definitionId=1&branchName=develop
:alt: Azure tests status (Linux, macOS, Windows)

.. |docs-rtd| image:: https://readthedocs.org/projects/scancode-toolkit/badge/?version=latest
:target: https://scancode-toolkit.readthedocs.io/en/latest/?badge=latest
.. |docs-rtd| image:: https://readthedocs.org/projects/scancode-toolkit/badge/?version=stable
:target: https://scancode-toolkit.readthedocs.io/en/stable/?badge=stable
:alt: Documentation Status

.. |docs-github-actions| image:: https://github.com/nexB/scancode-toolkit/actions/workflows/docs-ci.yml/badge.svg?branch=develop
Expand Down
Loading