Skip to content
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.

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

Fix SCTK doc build #3636

Merged
merged 13 commits into from
Jan 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
20 changes: 0 additions & 20 deletions .cirrus.yml

This file was deleted.

34 changes: 0 additions & 34 deletions .coveragerc

This file was deleted.

120 changes: 0 additions & 120 deletions .github/ISSUE_TEMPLATE/--first-timers-only.md

This file was deleted.

86 changes: 0 additions & 86 deletions .github/ISSUE_TEMPLATE/--good-first-issue.md

This file was deleted.

6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
blank_issues_enabled: true
contact_links:
- name: Gitter Chat
url: https://gitter.im/aboutcode-org/discuss
- name: Matrix Chat
url: https://matrix.to/#/#aboutcode-org_discuss:gitter.im
about: Please ask questions here.
- name: Code Of Conduct
url: https://github.com/nexB/scancode-toolkit/blob/develop/CODE_OF_CONDUCT.rst
about: This space is protected by our Code Of Conduct.
about: This space is protected by our Code Of Conduct.
4 changes: 2 additions & 2 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ Make sure these boxes are checked before your pull request (PR) is ready to be r
* [ ] Tests pass -- look for a green checkbox ✔️ a few minutes after opening your PR
Run [tests](https://scancode-toolkit.readthedocs.io/en/latest/contribute/contrib_dev.html#running-tests) locally to check for errors.
* [ ] Commits are in uniquely-named feature branch and has no merge conflicts 📁
* [ ] Looked for possible updates in documentation and added updates if applicable
* [ ] Updated CHANGELOG.rst
* [ ] Updated documentation pages (if applicable)
* [ ] Updated CHANGELOG.rst (if applicable)
<!--
We're happy to help you get this ready -- don't be afraid to ask for help, and **don't be discouraged**
if your tests fail at first!
Expand Down
3 changes: 0 additions & 3 deletions .github/workflows/docs-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,6 @@ jobs:
with:
python-version: ${{ matrix.python-version }}

- name: Give permission to run scripts
run: chmod +x ./docs/scripts/doc8_style_check.sh

- name: Install Dependencies
run: pip install -e .[docs]

Expand Down
6 changes: 6 additions & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@
# Required
version: 2

# Build in latest ubuntu/python
build:
os: ubuntu-22.04
tools:
python: "3.11"

# Build PDF & ePub
formats:
- epub
Expand Down
19 changes: 0 additions & 19 deletions appveyor.yml

This file was deleted.

2 changes: 1 addition & 1 deletion configure
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ PROD_REQUIREMENTS="scancode_toolkit*.whl"
VIRTUALENV_DIR=venv

# Cleanable files and directories to delete with the --clean option
CLEANABLE="build dist venv .cache .eggs"
CLEANABLE="tmp build dist venv .cache .eggs"
AyanSinhaMahapatra marked this conversation as resolved.
Show resolved Hide resolved

# extra arguments passed to pip
PIP_EXTRA_ARGS=" "
Expand Down
2 changes: 1 addition & 1 deletion configure.bat
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ set "REL_REQUIREMENTS=--requirement etc/scripts/requirements.txt"
set "VIRTUALENV_DIR=venv"

@rem # Cleanable files and directories to delete with the --clean option
set "CLEANABLE=build dist venv .cache .eggs"
set "CLEANABLE=tmp build dist venv .cache .eggs"

@rem # extra arguments passed to pip
set "PIP_EXTRA_ARGS= "
Expand Down
14 changes: 7 additions & 7 deletions docs/source/cli-reference/basic-options.rst
Original file line number Diff line number Diff line change
Expand Up @@ -580,26 +580,26 @@

The ``--license-url-template`` option sets the template URL used for the license reference URLs.

The default template URL is : [https://enterprise.dejacode.com/urn/urn:dje:license:{}]
The default template URL is : [https://scancode-licensedb.aboutcode.org/{}]
In a template URL, curly braces ({}) are replaced by the license key.

So, by default the license reference URL points to the dejacode page for that license.
So, by default the license reference URL points to the LicenseDB page for that license.

A scan example using the ``--license-url-template TEXT`` option ::

scancode -clpieu --json-pp output.json samples --license-url-template https://github.com/nexB/scancode-toolkit/tree/develop/src/licensedcode/data/licenses/{}.yml
scancode -clpieu --json-pp output.json samples --license-url-template https://github.com/nexB/scancode-toolkit/tree/develop/src/licensedcode/data/licenses/{}.LICENSE

In a normal scan, reference url for "ZLIB License" is as follows::

"reference_url": "https://enterprise.dejacode.com/urn/urn:dje:license:zlib",
"reference_url": "https://scancode-licensedb.aboutcode.org/zlib",

After using the option in the following manner::

``--license-url-template https://github.com/nexB/scancode-toolkit/tree/develop/src/licensedcode/data/licenses/{}``
``--license-url-template https://github.com/nexB/scancode-toolkit/tree/develop/src/licensedcode/data/licenses/{}.LICENSE``

the reference URL changes to this `zlib.yml file <https://github.com/nexB/scancode-toolkit/blob/develop/src/licensedcode/data/licenses/zlib.yml>`_::
the reference URL changes to this `zlib.LICENSE file <https://github.com/nexB/scancode-toolkit/blob/develop/src/licensedcode/data/licenses/zlib.LICENSE>`_::

"reference_url": "https://github.com/nexB/scancode-toolkit/tree/develop/src/licensedcode/data/licenses/zlib.yml",
"reference_url": "https://github.com/nexB/scancode-toolkit/blob/develop/src/licensedcode/data/licenses/zlib.LICENSE",

The reference URL changes for all detected licenses in the scan, across the scan result file.

Expand Down
6 changes: 6 additions & 0 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,12 @@
"scancode-workbench": ("https://scancode-workbench.readthedocs.io/en/latest/", None),
}

# List of regular expressions for the linkchecker to ignore
# See https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-the-linkcheck-builder
linkcheck_ignore = [
r'https://en.wikipedia.org/wiki/*',
r'https://matrix.to/*'
]

# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]
Expand Down
Loading