Skip to content

Commit c019c2f

Browse files
OmkarPhOmkarPh
authored
Merge pull request #628 from nexB/docs/license-review-todos-newui
Updated illustrations corresponding to new UI for to-do, reviews, matches table
2 parents 461135f + 3f55592 commit c019c2f

32 files changed

+139
-64
lines changed

‎.husky/pre-commit‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,4 @@
22
. "$(dirname -- "$0")/_/husky.sh"
33

44
npm test
5+
cd docs && ./scripts/doc8_style_check.sh && ./scripts/sphinx_build_link_check.sh

‎Release.md‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,11 @@
55
- Build filetree with missing directories to support `--only-findings` scans by @OmkarPh #624
66
- Sort the files in tableview by their depth in directory tree by @OmkarPh in #625
77

8+
### Note - Due to new features & schema changes, you'll have to re-import scans in workbench, previously generated sqlite files aren't compatible with this and further releases
9+
810
## ScanCode Toolkit Compatibility
911

10-
This v4.0.0 of ScanCode Workbench is compatible with scans from any [ScanCode Toolkit](https://github.com/nexB/scancode-toolkit/) releases at or after [`v32.0.0`](https://github.com/nexB/scancode-toolkit/releases/tag/v32.0.0rc4) and also from the latest develop, but using the latest `v32.x` stable releases is recommended: [latest SCTK release](https://github.com/nexB/scancode-toolkit/releases/latest).
12+
This v4.0.1 of ScanCode Workbench is compatible with scans from any [ScanCode Toolkit](https://github.com/nexB/scancode-toolkit/) releases at or after [`v32.0.0`](https://github.com/nexB/scancode-toolkit/releases/tag/v32.0.0rc4) and also from the latest develop, but using the latest `v32.x` stable releases is recommended: [latest SCTK release](https://github.com/nexB/scancode-toolkit/releases/latest).
1113

1214
## Bug fixes
1315

@@ -25,4 +27,4 @@ This v4.0.0 of ScanCode Workbench is compatible with scans from any [ScanCode To
2527

2628
# New Contributors
2729

28-
- @dotarjun made his first contribution in #615
30+
- @dotarjun made his first contribution in #615

‎attribution.html‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,25 +25,25 @@
2525
</head>
2626

2727
<body>
28-
<h1>Attribution for ScanCode Workbench 4.0.0 by nexB</h1>
28+
<h1>Attribution for ScanCode Workbench 4.0.1 by nexB</h1>
2929

3030
<p>
3131
For instructions on how to obtain a copy of any source code being made
3232
publicly available by nexB Inc. related to software used in ScanCode
3333
Workbench you may send your request in writing to:<br /><br />
3434
nexB Inc.<br />
3535
</p>
36-
<p>735 Industrial Road #101<br />San Carlos, CA 94070<br />USA</p>
36+
<p>4966 El Camino Real, Suite 119,<br />Los Altos, CA 94022<br />USA</p>
3737
<p></p>
3838
<p>
3939
Contact:
4040
<a href="http://www.nexb.com/" rel="nofollow">http://www.nexb.com/</a>
4141
</p>
4242

43-
<h2>About ScanCode Workbench 4.0.0:</h2>
43+
<h2>About ScanCode Workbench 4.0.1:</h2>
4444

4545
<p>
46-
ScanCode Workbench 4.0.0 is licensed under
46+
ScanCode Workbench 4.0.1 is licensed under
4747
<a href="#license_apache-2.0">Apache 2.0</a> AND
4848
<a href="#license_mit">MIT License</a> AND
4949
<a href="#license_cc0-1.0">CC0-1.0</a> AND
@@ -86,7 +86,7 @@ <h2>About ScanCode Workbench 4.0.0:</h2>
8686
You may also contact us to request the source code by email at [email protected] or
8787
by postal mail at:
8888
nexB Inc., ScanCode Workbench open source code request
89-
735 Industrial Road, Suite #101, 94070 San Carlos, CA, USA
89+
4966 El Camino Real, Suite 119, Los Altos, CA 94022, USA
9090
Please indicate in your communication the ScanCode Workbench version for which you are
9191
requesting source code.
9292

‎docs/Makefile‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ docs:
2020
@echo
2121
@echo "Starting up the docs server..."
2222
@echo
23+
make clean
2324
$(SPHINXAUTOBUILD) --port 8000 --watch ${SOURCEDIR} $(SOURCEDIR) "$(BUILDDIR)/html" $(SPHINXOPTS) $(O)
2425

2526
# Catch-all target: route all unknown targets to Sphinx using the new

‎docs/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ The first step you want to do is create the python virtual environment:
44

55
```
66
$ cd docs/
7-
$ python3 -m venv venv
7+
$ python -m venv venv
88
$ source venv/bin/activate
99
$ pip install -r requirements.txt
1010
```

‎docs/requirements.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,4 @@ doc8>=0.11.2
77
jinja2
88
markupSafe
99
sphinx-copybutton
10+
sphinx_rtd_dark_mode

‎docs/source/_static/favicon.ico‎

401 KB
Binary file not shown.

‎docs/source/conf.py‎

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,8 @@
2222
author = 'nexB Inc. and others'
2323
github_user = "nexB"
2424
github_repo = "scancode-workbench"
25-
github_branch = "update/docs"
25+
github_branch = "develop"
26+
html_favicon = '_static/favicon.ico'
2627

2728
# -- General configuration ---------------------------------------------------
2829

@@ -36,6 +37,7 @@
3637
"sphinx_reredirects",
3738
"sphinx.ext.extlinks",
3839
"sphinx_copybutton",
40+
"sphinx.ext.autosectionlabel",
3941
]
4042

4143

@@ -85,7 +87,7 @@
8587
"conf_py_path": "/docs/source/", # path in the checkout to the docs root
8688
}
8789

88-
html_css_files = ["_static/theme_overrides.css"]
90+
html_css_files = ["theme_overrides.css"]
8991

9092

9193
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
@@ -115,6 +117,11 @@
115117
'scan_samples': (f"https://github.com/{github_user}/{github_repo}/blob/{github_branch}/samples/%s", '%s'),
116118
}
117119

120+
# Ignore following links in linkcheck
121+
linkcheck_ignore = [
122+
'https://matrix.to/#/#aboutcode-org_discuss:gitter.im'
123+
]
124+
118125
# -- Options for LaTeX output -------------------------------------------------
119126

120127
latex_elements = {

‎docs/source/contribute/building.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ Create python environment, make docs
100100
cd docs/
101101
102102
# Setup virtual environment for python dependencies
103-
python3 -m venv venv
103+
python -m venv venv
104104
source venv/bin/activate
105105
106106
# Install dependencies

‎docs/source/getting-started/index.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Download and Install
1414
Once downloaded, you'll find the ScanCode Workbench executable inside the
1515
``ScanCode Workbench-<os>-<arch>`` folder.
1616

17-
On Windows 10, for example, the executable will be named `ScanCode-Workbench.exe`.
17+
On Windows 10, for example, the executable will be named `ScanCode-Workbench-4.0.1.exe`.
1818

1919
.. include:: ../rst_snippets/centos-note.rst
2020

0 commit comments

Comments
 (0)