sphinx-doc/sphinx

Support LibreJS in HTML - machine readable license

Open

#12 323 ouverte le 24 avr. 2024

Voir sur GitHub
 (3 commentaires) (0 réactions) (0 assignés)Python (1 985 forks)batch import
easygood first issuetype:enhancement

Métriques du dépôt

Stars
 (5 625 stars)
Métriques de merge PR
 (Merge moyen 13j 10h) (8 PRs mergées en 30 j)

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/

Guide contributeur

Direction de recherche
La demande de l'issue est d'ajouter des commentaires de licence aux fichiers JavaScript générés par Sphinx. Examinez comment Sphinx génère les ressources JavaScript, probablement dans les répertoires `sphinx/builders` ou `sphinx/themes`. Recherchez les fichiers de modèles existants qui produisent des balises `<script>`. Envisagez d'utiliser le format `@license magnet` ou les en têtes SPDX. Il n'y a pas encore de PR liés ou de commentaires des mainteneurs, donc la première étape est de localiser le code pertinent qui écrit les fichiers JavaScript.
Stack technique
javascriptpythonhtml
Domaine
documentationfrontend
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Plutôt claire
Prérequis
Basic knowledge of SphinxUnderstanding of JavaScript licenses
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70