Skip to content

Commit 5c2ce39

Browse files
Fix include links and update conf.py
Fix broken include and image links to delete "scancode-toolkit/" and update conf.py to point to aboutcode.readthedocs.io by intersphinx Signed-off-by: Ayan Sinha Mahapatra <[email protected]>
1 parent 39e2a03 commit 5c2ce39

24 files changed

+95
-82
lines changed

docs/source/cli-reference/basic-options.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
`Basic` Options
22
===============
33

4-
.. include:: /scancode-toolkit/rst_snippets/basic_options.rst
4+
.. include:: /rst_snippets/basic_options.rst
55

66
----
77

8-
.. include:: /scancode-toolkit/rst_snippets/note_snippets/synopsis_install_quickstart.rst
8+
.. include:: /rst_snippets/note_snippets/synopsis_install_quickstart.rst
99

1010
----
1111

docs/source/cli-reference/core-options.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@
33

44
.. _cli_core:
55

6-
.. include:: /scancode-toolkit/rst_snippets/core_options.rst
6+
.. include:: /rst_snippets/core_options.rst
77

88
----
99

10-
.. include:: /scancode-toolkit/rst_snippets/note_snippets/synopsis_install_quickstart.rst
10+
.. include:: /rst_snippets/note_snippets/synopsis_install_quickstart.rst
1111

1212
----
1313

docs/source/cli-reference/help-text-options.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ from the command line itself. These are two options are ``--help`` and ``--examp
66
very helpful if you need a quick glance of the options or use cases. Or it can be useful when you
77
can't access, the more elaborate online documentation.
88

9-
.. include:: /scancode-toolkit/rst_snippets/doc_help.rst
9+
.. include:: /rst_snippets/doc_help.rst
1010

1111
.. _cli_help_text:
1212

@@ -24,7 +24,7 @@ To see the help text from the Terminal, execute the following command::
2424

2525
$ scancode --help
2626

27-
.. include:: /scancode-toolkit/rst_snippets/note_snippets/synopsis_install_quickstart.rst
27+
.. include:: /rst_snippets/note_snippets/synopsis_install_quickstart.rst
2828

2929
The Following Help Text is displayed, i.e. This is the help text for Scancode Version 3.1.1 ::
3030

@@ -231,7 +231,7 @@ To see the help text from the Terminal, execute the following command::
231231

232232
$ scancode --examples
233233

234-
.. include:: /scancode-toolkit/rst_snippets/note_snippets/synopsis_install_quickstart.rst
234+
.. include:: /rst_snippets/note_snippets/synopsis_install_quickstart.rst
235235

236236
The Following Text is displayed, i.e. This is the examples for Scancode Version 3.1.1 ::
237237

@@ -305,7 +305,7 @@ To see the help text from the Terminal, execute the following command::
305305

306306
$ scancode --plugins
307307

308-
.. include:: /scancode-toolkit/rst_snippets/note_snippets/synopsis_install_quickstart.rst
308+
.. include:: /rst_snippets/note_snippets/synopsis_install_quickstart.rst
309309

310310
.. note::
311311

docs/source/cli-reference/list-options.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,32 +18,32 @@ There's also another section for ``extractcode`` options.
1818
The order of the sections and all their options is the same as in the :ref:'cli_help_text',
1919
available in the command line.
2020

21-
.. include:: /scancode-toolkit/rst_snippets/note_snippets/synopsis_install_quickstart.rst
21+
.. include:: /rst_snippets/note_snippets/synopsis_install_quickstart.rst
2222

2323
.. _cli_basic:
2424

25-
.. include:: /scancode-toolkit/rst_snippets/basic_options.rst
25+
.. include:: /rst_snippets/basic_options.rst
2626

2727
----
2828

29-
.. include:: /scancode-toolkit/rst_snippets/extract.rst
29+
.. include:: /rst_snippets/extract.rst
3030

3131
----
3232

33-
.. include:: /scancode-toolkit/rst_snippets/core_options.rst
33+
.. include:: /rst_snippets/core_options.rst
3434

3535
----
3636

37-
.. include:: /scancode-toolkit/rst_snippets/output_format_options.rst
37+
.. include:: /rst_snippets/output_format_options.rst
3838

3939
----
4040

41-
.. include:: /scancode-toolkit/rst_snippets/output_control_options.rst
41+
.. include:: /rst_snippets/output_control_options.rst
4242

4343
----
4444

45-
.. include:: /scancode-toolkit/rst_snippets/pre_scan_options.rst
45+
.. include:: /rst_snippets/pre_scan_options.rst
4646

4747
----
4848

49-
.. include:: /scancode-toolkit/rst_snippets/post_scan_options.rst
49+
.. include:: /rst_snippets/post_scan_options.rst

docs/source/cli-reference/output-filters-and-control.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@
33
Controlling Scancode Output and Filters
44
=======================================
55

6-
.. include:: /scancode-toolkit/rst_snippets/output_control_options.rst
6+
.. include:: /rst_snippets/output_control_options.rst
77

88
----
99

10-
.. include:: /scancode-toolkit/rst_snippets/note_snippets/synopsis_install_quickstart.rst
10+
.. include:: /rst_snippets/note_snippets/synopsis_install_quickstart.rst
1111

1212
----
1313

@@ -43,7 +43,7 @@ Controlling Scancode Output and Filters
4343

4444
"path": "JGroups/LICENSE"
4545

46-
.. include:: /scancode-toolkit/rst_snippets/note_snippets/control_strip_full_root.rst
46+
.. include:: /rst_snippets/note_snippets/control_strip_full_root.rst
4747

4848
----
4949

@@ -61,7 +61,7 @@ Controlling Scancode Output and Filters
6161

6262
More information on :ref:`glob_pattern_matching`.
6363

64-
.. include:: /scancode-toolkit/rst_snippets/warning_snippets/control_ignore_author_copyright.rst
64+
.. include:: /rst_snippets/warning_snippets/control_ignore_author_copyright.rst
6565

6666
----
6767

docs/source/cli-reference/output-format.rst

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,19 @@ Scancode Output Formats
66
Scan results generated by Scancode are available in different formats, to be specified by the
77
following options.
88

9-
.. include:: /scancode-toolkit/rst_snippets/output_format_options.rst
9+
.. include:: /rst_snippets/output_format_options.rst
1010

11-
.. include:: /scancode-toolkit/rst_snippets/note_snippets/output_samples.rst
11+
.. include:: /rst_snippets/note_snippets/output_samples.rst
1212

1313
----
1414

15-
.. include:: /scancode-toolkit/rst_snippets/note_snippets/synopsis_install_quickstart.rst
15+
.. include:: /rst_snippets/note_snippets/synopsis_install_quickstart.rst
1616

1717
----
1818

1919
.. _output_to_stdout:
2020

21-
.. include:: /scancode-toolkit/rst_snippets/stdout.rst
21+
.. include:: /rst_snippets/stdout.rst
2222

2323
----
2424

@@ -29,14 +29,14 @@ following options.
2929
others. Scancode Workbench and other applications that use Scancode Result data as input accept
3030
only the ``json`` format.
3131

32-
.. include:: /scancode-toolkit/rst_snippets/note_snippets/output_json_notdef.rst
32+
.. include:: /rst_snippets/note_snippets/output_json_notdef.rst
3333

3434
The following code performs a scan on the samples directory, and publishes the results in
3535
``json`` format::
3636

3737
scancode -clpieu --json output.json samples
3838

39-
.. include:: /scancode-toolkit/rst_snippets/note_snippets/output_json_ugly.rst
39+
.. include:: /rst_snippets/note_snippets/output_json_ugly.rst
4040

4141
.. figure:: data/json_ugly.png
4242

@@ -313,7 +313,7 @@ following options.
313313
{"files":[{"path":"samples/zlib/iostream2/zstream_test.cpp", ... "scan_errors":[]}]}
314314

315315

316-
.. include:: /scancode-toolkit/rst_snippets/note_snippets/output_jsonlines.rst
316+
.. include:: /rst_snippets/note_snippets/output_jsonlines.rst
317317

318318
----
319319

@@ -461,7 +461,7 @@ Comparing Different ``json`` Output Formats
461461
ScanCode also supports formatting the output in a HTML visualization tool, which is more
462462
helpful than the standard HTML format.
463463

464-
.. include:: /scancode-toolkit/rst_snippets/warning_snippets/output_htmlapp_dep.rst
464+
.. include:: /rst_snippets/warning_snippets/output_htmlapp_dep.rst
465465

466466
The following code performs a scan on the samples directory, and publishes the results in
467467
``html-app`` format::
@@ -480,7 +480,7 @@ Comparing Different ``json`` Output Formats
480480
- File Details
481481
- Packages
482482

483-
.. include:: /scancode-toolkit/rst_snippets/note_snippets/output_htmlapp_search.rst
483+
.. include:: /rst_snippets/note_snippets/output_htmlapp_search.rst
484484

485485
.. figure:: data/output_html_app1.png
486486

@@ -577,4 +577,4 @@ Comparing Different ``json`` Output Formats
577577

578578
----
579579

580-
.. include:: /scancode-toolkit/rst_snippets/custom_output_format.rst
580+
.. include:: /rst_snippets/custom_output_format.rst

docs/source/cli-reference/scan-options-post.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,15 @@ Post-Scan Options
55

66
Post-Scan options activate their respective post-scan plugins which execute the task.
77

8-
.. include:: /scancode-toolkit/rst_snippets/post_scan_options.rst
8+
.. include:: /rst_snippets/post_scan_options.rst
99

1010
----
1111

12-
.. include:: /scancode-toolkit/rst_snippets/note_snippets/synopsis_install_quickstart.rst
12+
.. include:: /rst_snippets/note_snippets/synopsis_install_quickstart.rst
1313

1414
To see all plugins available via command line help, use ``--plugins``.
1515

16-
.. include:: /scancode-toolkit/rst_snippets/note_snippets/post_scan_plugins.rst
16+
.. include:: /rst_snippets/note_snippets/post_scan_plugins.rst
1717

1818
----
1919

@@ -177,7 +177,7 @@ To see all plugins available via command line help, use ``--plugins``.
177177
Note that the license objects for each detected license in the files already has "is_license_text"
178178
attributes by default, but not the file objects. They only have this attribute if the plugin is used.
179179

180-
.. include:: /scancode-toolkit/rst_snippets/warning_snippets/post_is_license_text.rst
180+
.. include:: /rst_snippets/warning_snippets/post_is_license_text.rst
181181

182182
----
183183

@@ -249,13 +249,13 @@ To see all plugins available via command line help, use ``--plugins``.
249249
icon: icon-ok-circle
250250

251251

252-
.. include:: /scancode-toolkit/rst_snippets/note_snippets/post_lic_pol_key.rst
252+
.. include:: /rst_snippets/note_snippets/post_lic_pol_key.rst
253253

254254
Applying License Policies during a ScanCode scan, using the ``--license-policy`` Plugin::
255255

256256
scancode -clipeu --json-pp output.json samples --license-policy policy-file.yml
257257

258-
.. include:: /scancode-toolkit/rst_snippets/note_snippets/post_lic_pol_notsub.rst
258+
.. include:: /rst_snippets/note_snippets/post_lic_pol_notsub.rst
259259

260260
This adds to every file/directory an object "license_policy", having as further attributes under it
261261
the fields as specified in the .YAML file. Here according to our example .YAML file, the attributes
@@ -449,7 +449,7 @@ To see all plugins available via command line help, use ``--plugins``.
449449

450450
scancode -clieu --json-pp output.json samples --summary --facet dev="*.java" --facet dev="*.c" --summary-by-facet
451451

452-
.. include:: /scancode-toolkit/rst_snippets/note_snippets/pre_facet_core.rst
452+
.. include:: /rst_snippets/note_snippets/pre_facet_core.rst
453453

454454
..
455455
[ToDo] Remove this Warning when Issue solved.
@@ -578,7 +578,7 @@ To see all plugins available via command line help, use ``--plugins``.
578578
},
579579
],
580580

581-
.. include:: /scancode-toolkit/rst_snippets/note_snippets/post_summary_facet.rst
581+
.. include:: /rst_snippets/note_snippets/post_summary_facet.rst
582582

583583
For users who want to know :ref:`what_is_a_facet`.
584584

@@ -677,7 +677,7 @@ To see all plugins available via command line help, use ``--plugins``.
677677

678678
scancode -clpieu --json-pp output.json samples --summary-with-details
679679

680-
.. include:: /scancode-toolkit/rst_snippets/note_snippets/post_summary_details.rst
680+
.. include:: /rst_snippets/note_snippets/post_summary_details.rst
681681

682682
A sample file object in the scan results (a directory level summary of ``samples/arch``) is
683683
structured as follows::

docs/source/cli-reference/scan-options-pre.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@
33
Pre-Scan Options
44
================
55

6-
.. include:: /scancode-toolkit/rst_snippets/pre_scan_options.rst
6+
.. include:: /rst_snippets/pre_scan_options.rst
77

88
----
99

10-
.. include:: /scancode-toolkit/rst_snippets/note_snippets/synopsis_install_quickstart.rst
10+
.. include:: /rst_snippets/note_snippets/synopsis_install_quickstart.rst
1111

1212
----
1313

@@ -122,7 +122,7 @@ Pre-Scan Options
122122
"dev"
123123
],
124124

125-
.. include:: /scancode-toolkit/rst_snippets/note_snippets/pre_facet_core.rst
125+
.. include:: /rst_snippets/note_snippets/pre_facet_core.rst
126126

127127
For each facet, the ``--facet`` option precedes the ``<facet>=<pattern>`` argument. For specifying
128128
multiple facets, this whole part is repeated, including the ``--facet`` option.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
.. _how_to_run_a_scan:
22

3-
.. include:: /scancode-toolkit/tutorials/how_to_run_a_scan.rst
3+
.. include:: /tutorials/how_to_run_a_scan.rst

docs/source/cli-reference/synopsis.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ The basic usage in case of a download and configure installation (on Linux/MacOS
3939

4040
path/to/scancode [OPTIONS] <OUTPUT FORMAT OPTION(s)> <SCAN INPUT>
4141

42-
.. include:: /scancode-toolkit/rst_snippets/tip_snippets/synopsis_quickstart.rst
42+
.. include:: /rst_snippets/tip_snippets/synopsis_quickstart.rst
4343

4444
Here Scancode scans the <SCAN INPUT> file or directory for license, origin and packages and saves
4545
results to FILE(s) using one or more output format option. Error and progress are printed to
@@ -49,7 +49,7 @@ To scan the ``samples`` directory distributed with ScanCode-Toolkit, the command
4949

5050
scancode -clpieu --json-pp path/to/output.json path/to/samples
5151

52-
.. include:: /scancode-toolkit/rst_snippets/note_snippets/synopsis_output_format.rst
52+
.. include:: /rst_snippets/note_snippets/synopsis_output_format.rst
5353

5454
Alternatively, in case of download and configure installations, where ``path/to/scancode`` is used
5555
(the path from root of file system) we can go into the scancode directory
@@ -97,7 +97,7 @@ is JSON. If ``--json`` is used, the entire file being in one line, without white
9797
The following example scans will show you how to run a scan with each of the result formats. For
9898
the scans, we will use the ``samples`` directory provided with the ScanCode Toolkit.
9999

100-
.. include:: /scancode-toolkit/rst_snippets/tip_snippets/stdout.rst
100+
.. include:: /rst_snippets/tip_snippets/stdout.rst
101101

102102
JSON file output
103103
^^^^^^^^^^^^^^^^
@@ -296,4 +296,4 @@ file. When the scan is done, open ``samples.html`` in your web browser.
296296
.. image:: data/scancode-toolkit-static-html1.png
297297
.. image:: data/scancode-toolkit-static-html2.png
298298

299-
.. include:: /scancode-toolkit/rst_snippets/other_imp_doc.rst
299+
.. include:: /rst_snippets/other_imp_doc.rst

0 commit comments

Comments
 (0)