sphinx-doc/sphinx

Support LibreJS in HTML - machine readable license

Open

#12.323 geöffnet am 24. Apr. 2024

Auf GitHub ansehen
 (3 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Python (1.985 Forks)batch import
easygood first issuetype:enhancement

Repository-Metriken

Stars
 (5.625 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 13T 10h) (8 gemergte PRs in 30 T)

Beschreibung

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

Research-Richtung
Das Issue fordert das Hinzufügen von Lizenzkommentaren zu den von Sphinx generierten JavaScript Dateien. Untersuche, wie Sphinx JavaScript Assets generiert, wahrscheinlich in den Verzeichnissen `sphinx/builders` oder `sphinx/themes`. Suche nach vorhandenen Template Dateien, die `<script>` Tags ausgeben. Erwäge die Verwendung des `@license magnet` Formats oder von SPDX Headern. Es gibt noch keine verknüpften PRs oder Maintainer Kommentare, daher ist der erste Schritt, den relevanten Code zu finden, der die JavaScript Dateien schreibt.
Tech Stack
javascriptpythonhtml
Domain
documentationfrontend
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Meist klar
Voraussetzungen
Basic knowledge of SphinxUnderstanding of JavaScript licenses
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70