Skip to content

Commit cd4574f

Browse files
committed
Fixed #4445 - Added reference links to the TOC and the Scan Output Options page within the 'Output Formats' section.
Signed-off-by: Chin Yeung Li <[email protected]>
1 parent 0c435c9 commit cd4574f

File tree

2 files changed

+12
-6
lines changed

2 files changed

+12
-6
lines changed

docs/source/cli-reference/synopsis.rst

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@ ScanCode detects licenses, copyrights, package manifests and direct dependencies
77
in source code and binary files, by scanning the files. This page introduces you to the ScanCode
88
Toolkit Command Line Interface in the following sections:
99

10-
- Quickstart
11-
- Type of Options
12-
- Output Formats
13-
- Other Important Documentation
10+
- :ref:`synopsis_quickstart`
11+
- :ref:`scancode_cli_options`
12+
- :ref:`synopsis_output`
13+
- :ref:`other_imp_doc`
1414

1515

1616
.. _synopsis_quickstart:
@@ -79,8 +79,10 @@ Line Options listed under each section.
7979
Output Formats
8080
--------------
8181

82-
The output file format is set by using the various output options. The recommended output format
83-
is JSON. If ``--json`` is used, the entire file being in one line, without whitespace characters.
82+
The output file format is set by using the various output options. See
83+
:ref:`scan_output_options`. The recommended output format is JSON. If
84+
``--json`` is used, the entire file being in one line, without whitespace
85+
characters.
8486

8587
The following example scans will show you how to run a scan with each of the result formats. For
8688
the scans, we will use the ``samples`` directory provided with the ScanCode Toolkit.
@@ -286,4 +288,6 @@ file. When the scan is done, open ``samples.html`` in your web browser.
286288
.. image:: data/scancode-toolkit-static-html1.png
287289
.. image:: data/scancode-toolkit-static-html2.png
288290

291+
.. _other_imp_doc:
292+
289293
.. include:: /rst_snippets/other_imp_doc.rst

docs/source/rst_snippets/output_format_options.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _scan_output_options:
2+
13
All Scan Output Options
24
-----------------------
35

0 commit comments

Comments
 (0)