Skip to content

Add LibreJS and SPDX license headers to bundled JavaScript files#14351

Open
coder999999999 wants to merge 1 commit intosphinx-doc:masterfrom
coder999999999:fix/librejs-spdx-license-headers-12323
Open

Add LibreJS and SPDX license headers to bundled JavaScript files#14351
coder999999999 wants to merge 1 commit intosphinx-doc:masterfrom
coder999999999:fix/librejs-spdx-license-headers-12323

Conversation

@coder999999999
Copy link
Copy Markdown

Closes #12323

Adds machine-readable license information to the three JavaScript files shipped with the basic Sphinx theme (doctools.js, searchtools.js, sphinx_highlight.js).

Each file now includes:

  • SPDX headers (SPDX-FileCopyrightText and SPDX-License-Identifier: BSD-2-Clause) per the REUSE specification
  • LibreJS tags (@license / @license-end) with the BSD-2-Clause magnet link per the GNU LibreJS format

This allows LibreJS (a browser extension that verifies JavaScript is free software before running it) to recognize Sphinx-generated JS as freely licensed instead of blocking it.

The magnet link magnet:?xt=urn:btih:87f119ba0b429ba17a44b4bffcab33165ebdacc0&dn=freebsd.txt corresponds to the BSD-2-Clause license in the LibreJS license list.

Add machine-readable license information to the three JavaScript files
shipped with the basic Sphinx theme:

- doctools.js
- searchtools.js
- sphinx_highlight.js

Each file now includes:
- SPDX-FileCopyrightText and SPDX-License-Identifier headers per
  the REUSE specification (https://reuse.software/)
- @license / @license-end tags per the GNU LibreJS specification
  (https://www.gnu.org/software/librejs/) using the BSD-2-Clause
  magnet link

This allows LibreJS to recognize Sphinx-generated JS as freely licensed,
instead of blocking it as non-free.

Closes sphinx-doc#12323
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Support LibreJS in HTML - machine readable license

1 participant