Skip to content

Commit 8ed4e40

Browse files
AyanSinhaMahapatraAyanSinhaMahapatra
authored
Merge pull request #602 from nexB/update/docs
Update Documentation
2 parents 4afe992 + 8a217c8 commit 8ed4e40

149 files changed

Lines changed: 1505 additions & 515 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/workflows/docs-ci.yml‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: CI Documentation
2+
3+
on: [push, pull_request]
4+
5+
permissions:
6+
contents: read # to fetch code (actions/checkout)
7+
8+
jobs:
9+
build:
10+
runs-on: ubuntu-20.04
11+
12+
strategy:
13+
max-parallel: 4
14+
matrix:
15+
python-version: [3.9]
16+
17+
steps:
18+
- name: Checkout code
19+
uses: actions/checkout@v3
20+
21+
- name: Set up Python ${{ matrix.python-version }}
22+
uses: actions/setup-python@v4
23+
with:
24+
python-version: ${{ matrix.python-version }}
25+
26+
- name: Install Dependencies
27+
run: pip install -r docs/requirements.txt
28+
29+
- name: Check Sphinx Documentation build minimally
30+
working-directory: ./docs
31+
run: sphinx-build -E -W source build
32+
33+
- name: Check for documentation style errors
34+
working-directory: ./docs
35+
run: ./scripts/doc8_style_check.sh
36+

‎.readthedocs.yml‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# .readthedocs.yml
2+
# Read the Docs configuration file
3+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
4+
5+
# Required
6+
version: 2
7+
8+
# Build PDF & ePub
9+
formats:
10+
- epub
11+
- pdf
12+
13+
# Where the Sphinx conf.py file is located
14+
sphinx:
15+
configuration: docs/source/conf.py
16+
17+
# specify build OS
18+
build:
19+
os: ubuntu-22.04
20+
tools:
21+
python: "3.11"
22+
23+
# Setting the python version and doc build requirements
24+
python:
25+
install:
26+
- requirements: docs/requirements.txt

‎CODE_OF_CONDUCT.rst‎

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
Contributor Covenant Code of Conduct
2+
====================================
3+
4+
Our Pledge
5+
----------
6+
7+
In the interest of fostering an open and welcoming environment, we as
8+
contributors and maintainers pledge to making participation in our
9+
project and our community a harassment-free experience for everyone,
10+
regardless of age, body size, disability, ethnicity, gender identity and
11+
expression, level of experience, education, socio-economic status,
12+
nationality, personal appearance, race, religion, or sexual identity and
13+
orientation.
14+
15+
Our Standards
16+
-------------
17+
18+
Examples of behavior that contributes to creating a positive environment
19+
include:
20+
21+
- Using welcoming and inclusive language
22+
- Being respectful of differing viewpoints and experiences
23+
- Gracefully accepting constructive criticism
24+
- Focusing on what is best for the community
25+
- Showing empathy towards other community members
26+
27+
Examples of unacceptable behavior by participants include:
28+
29+
- The use of sexualized language or imagery and unwelcome sexual
30+
attention or advances
31+
- Trolling, insulting/derogatory comments, and personal or political
32+
attacks
33+
- Public or private harassment
34+
- Publishing others’ private information, such as a physical or
35+
electronic address, without explicit permission
36+
- Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
Our Responsibilities
40+
--------------------
41+
42+
Project maintainers are responsible for clarifying the standards of
43+
acceptable behavior and are expected to take appropriate and fair
44+
corrective action in response to any instances of unacceptable behavior.
45+
46+
Project maintainers have the right and responsibility to remove, edit,
47+
or reject comments, commits, code, wiki edits, issues, and other
48+
contributions that are not aligned to this Code of Conduct, or to ban
49+
temporarily or permanently any contributor for other behaviors that they
50+
deem inappropriate, threatening, offensive, or harmful.
51+
52+
Scope
53+
-----
54+
55+
This Code of Conduct applies both within project spaces and in public
56+
spaces when an individual is representing the project or its community.
57+
Examples of representing a project or community include using an
58+
official project e-mail address, posting via an official social media
59+
account, or acting as an appointed representative at an online or
60+
offline event. Representation of a project may be further defined and
61+
clarified by project maintainers.
62+
63+
Enforcement
64+
-----------
65+
66+
Instances of abusive, harassing, or otherwise unacceptable behavior may
67+
be reported by contacting the project team at pombredanne@gmail.com
68+
or on the Gitter chat channel at https://matrix.to/#/#aboutcode-org_discuss:gitter.im
69+
All complaints will be reviewed and investigated and will result in a
70+
response that is deemed necessary and appropriate to the circumstances.
71+
The project team is obligated to maintain confidentiality with regard to
72+
the reporter of an incident. Further details of specific enforcement
73+
policies may be posted separately.
74+
75+
Project maintainers who do not follow or enforce the Code of Conduct in
76+
good faith may face temporary or permanent repercussions as determined
77+
by other members of the project’s leadership.
78+
79+
Attribution
80+
-----------
81+
82+
This Code of Conduct is adapted from the `Contributor Covenant`_ ,
83+
version 1.4, available at
84+
https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
85+
86+
.. _Contributor Covenant: https://www.contributor-covenant.org

‎README.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ license and other notices identified by
1111
and other interesting information in your code.
1212

1313
ScanCode Workbench is based on
14-
[Electron](https://electron.atom.io/) and will be the primary desktop/GUI tool
14+
[Electron](https://www.electronjs.org/) and will be the primary desktop/GUI tool
1515
for using nexB’s [AboutCode tools](https://github.com/nexB/aboutcode). This app
1616
works on Windows, OS X and Linux operating systems.
1717

@@ -23,8 +23,8 @@ works on Windows, OS X and Linux operating systems.
2323
* You can [download the latest release](https://github.com/nexB/scancode-workbench/releases)
2424
for your operating system or build it yourself (see below). Once downloaded, you
2525
can find `ScanCode-Workbench` under `dist/ScanCode-Workbench-<os>-<arch>-<version>`
26-
* ScanCode Workbench >= v2 is only compatible with scans from
27-
[ScanCode v2.0.0](https://github.com/nexB/scancode-toolkit/releases) and
26+
* ScanCode Workbench >= v4 is only compatible with scans from
27+
[ScanCode v32.0.0](https://github.com/nexB/scancode-toolkit/releases) and
2828
above which are run with the ScanCode `-i` option. For a list of available ScanCode
2929
options see [How To: Set 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)
3030

@@ -96,6 +96,6 @@ See the NOTICE file for more details.
9696

9797
If you have a question, a suggestion or find a bug, enter an issue.
9898

99-
[![Gitter chat](https://badges.gitter.im/aboutcode-org/gitter.png)](https://gitter.im/aboutcode-org/discuss)
99+
[![Gitter chat](https://badges.gitter.im/aboutcode-org/gitter.png)](https://matrix.to/#/#aboutcode-org_discuss:gitter.im)
100100

101-
For questions and chats, you can join the Gitter channel at https://gitter.im/aboutcode-org/discuss
101+
For questions and chats, you can join the Gitter channel at https://matrix.to/#/#aboutcode-org_discuss:gitter.im

LICENSE renamed to apache-2.0.LICENSE

File renamed without changes.

‎archive_builder.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
#!/usr/bin/python
22

3-
# Copyright (c) 2017 - 2019 nexB Inc. http://www.nexb.com/ - All rights reserved.
3+
# Copyright (c) nexB Inc. and others. All rights reserved.
44

55
"""
66
Run this script to build ScanCode Workbench. The script detects which OS

‎attribution.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,13 +58,13 @@ <h2>About ScanCode Workbench 4.0.0:</h2>
5858
</p>
5959

6060
<pre>
61-
Copyright (c) 2016 - 2019 nexB Inc. and others. All rights reserved.</pre
61+
Copyright (c) nexB Inc. and others. All rights reserved.</pre
6262
>
6363
<pre>
6464
Software license
6565
================
6666

67-
Copyright (c) 2016 nexB Inc. and others. All rights reserved.
67+
Copyright (c) nexB Inc. and others. All rights reserved.
6868
https://nexb.com and https://github.com/nexB/scancode-workbench/
6969
The ScanCode Workbench software is licensed under the Apache License version 2.0.
7070
ScanCode is a trademark of nexB Inc.

‎docs/Makefile‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
# from the environment for the first two.
66
SPHINXOPTS ?=
77
SPHINXBUILD ?= sphinx-build
8+
SPHINXAUTOBUILD = sphinx-autobuild
89
SOURCEDIR = source
910
BUILDDIR = build
1011

@@ -14,6 +15,13 @@ help:
1415

1516
.PHONY: help Makefile
1617

18+
# Run the development server using sphinx-autobuild
19+
docs:
20+
@echo
21+
@echo "Starting up the docs server..."
22+
@echo
23+
$(SPHINXAUTOBUILD) --port 8000 --watch ${SOURCEDIR} $(SOURCEDIR) "$(BUILDDIR)/html" $(SPHINXOPTS) $(O)
24+
1725
# Catch-all target: route all unknown targets to Sphinx using the new
1826
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
1927
%: Makefile

‎docs/README.md‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,17 @@
22
The first step you want to do is create the python virtual environment:
33
```
44
$ cd docs/
5-
$ python3 -m venv .venv
6-
$ source .venv/bin/active
5+
$ python3 -m venv venv
6+
$ source venv/bin/activate
77
$ pip install -r requirements.txt
88
```
99

10-
Now, you can run the various Spinx build things:
10+
Run Sphinx documentation server:
11+
```
12+
$ make docs
13+
```
14+
15+
Build Sphinx documentation
1116
```
1217
$ make html
13-
$ etc
1418
```

‎docs/make.bat‎

Lines changed: 47 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,47 @@
1-
@ECHO OFF
2-
3-
pushd %~dp0
4-
5-
REM Command file for Sphinx documentation
6-
7-
if "%SPHINXBUILD%" == "" (
8-
set SPHINXBUILD=sphinx-build
9-
)
10-
set SOURCEDIR=source
11-
set BUILDDIR=build
12-
13-
if "%1" == "" goto help
14-
15-
%SPHINXBUILD% >NUL 2>NUL
16-
if errorlevel 9009 (
17-
echo.
18-
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
19-
echo.installed, then set the SPHINXBUILD environment variable to point
20-
echo.to the full path of the 'sphinx-build' executable. Alternatively you
21-
echo.may add the Sphinx directory to PATH.
22-
echo.
23-
echo.If you don't have Sphinx installed, grab it from
24-
echo.http://sphinx-doc.org/
25-
exit /b 1
26-
)
27-
28-
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
29-
goto end
30-
31-
:help
32-
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
33-
34-
:end
35-
popd
1+
@ECHO OFF
2+
3+
pushd %~dp0
4+
5+
REM Command file for Sphinx documentation
6+
7+
if "%SPHINXBUILD%" == "" (
8+
set SPHINXBUILD=sphinx-build
9+
)
10+
if "%SPHINXAUTOBUILD%" == "" (
11+
set SPHINXAUTOBUILD=sphinx-autobuild
12+
)
13+
set SOURCEDIR=source
14+
set BUILDDIR=build
15+
16+
if "%1" == "" goto help
17+
18+
if "%1" == "docs" goto docs
19+
20+
%SPHINXBUILD% >NUL 2>NUL
21+
if errorlevel 9009 (
22+
echo.
23+
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
24+
echo.installed, then set the SPHINXBUILD environment variable to point
25+
echo.to the full path of the 'sphinx-build' executable. Alternatively you
26+
echo.may add the Sphinx directory to PATH.
27+
echo.
28+
echo.If you don't have Sphinx installed, grab it from
29+
echo.http://sphinx-doc.org/
30+
exit /b 1
31+
)
32+
33+
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
34+
goto end
35+
36+
:docs
37+
@echo
38+
@echo Starting up the docs server...
39+
@echo
40+
%SPHINXAUTOBUILD% --port 8000 --watch %SOURCEDIR% %SOURCEDIR% %BUILDDIR%\html %SPHINXOPTS% %O%
41+
goto end
42+
43+
:help
44+
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
45+
46+
:end
47+
popd

0 commit comments

Comments
 (0)