sphinx-doc/sphinx

Support LibreJS in HTML - machine readable license

Open

#12,323 opened on Apr 24, 2024

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Python (5,625 stars) (1,985 forks)batch import
easygood first issuetype:enhancement

Description

LibreJS (https://www.gnu.org/software/librejs/) is a plug-in that check if the Java-Script is free software before running it.

Sphinx generates Java-Script that is free software, but LibreJS cannot see that, and therefore treats this as non-free.

There are several ways to tell LibreJS the license, but the easiest is probably to add a line in each script like this:

// @license magnet:?xt=urn:btih:87f119ba0b429ba17a44b4bffcab33165ebdacc0&dn=freebsd.txt

(Full list of licenses https://www.gnu.org/software/librejs/manual/html_node/Setting-Your-JavaScript-Free.html#License-tags)

And while we are on the subject of machine readable licenses: To support https://reuse.software/ it might make sense to also add:

// SPDX-FileCopyrightText: 2024 Foo Bar
// SPDX-License-Identifier: BSD-2-Clause

See full list on https://spdx.org/licenses/

Contributor guide

Tech stack
javascriptpythonhtml
Domain
documentationfrontend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Basic knowledge of SphinxUnderstanding of JavaScript licenses
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
The issue requests adding license comments to JavaScript files generated by Sphinx. Look at how Sphinx generates JavaScript assets, likely in the `sphinx/builders` or `sphinx/themes` directories. Search for existing template files that output `<script>` tags. Consider using the `@license magnet` format or SPDX headers. There are no linked PRs or maintainer comments yet, so the first step is to locate the relevant code that writes JavaScript files.