sphinx-doc/sphinx

Support LibreJS in HTML - machine readable license

Open

#12.323 aberto em 24 de abr. de 2024

Ver no GitHub
 (3 comments) (0 reactions) (0 assignees)Python (1.985 forks)batch import
easygood first issuetype:enhancement

Métricas do repositório

Stars
 (5.625 stars)
Métricas de merge de PR
 (Mesclagem média 13d 10h) (8 fundiu PRs em 30d)

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/

Guia do colaborador

Direção de pesquisa
A issue solicita a adição de comentários de licença aos arquivos JavaScript gerados pelo Sphinx. Examine como o Sphinx gera os ativos JavaScript, provavelmente nos diretórios `sphinx/builders` ou `sphinx/themes`. Procure por arquivos de modelo existentes que geram tags `<script>`. Considere usar o formato `@license magnet` ou cabeçalhos SPDX. Ainda não há PRs vinculados ou comentários dos mantenedores, então o primeiro passo é localizar o código relevante que escreve os arquivos JavaScript.
Pilha de tecnologia
javascriptpythonhtml
Domain
documentationfrontend
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Principalmente claro
Prerequisites
Basic knowledge of SphinxUnderstanding of JavaScript licenses
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70