sphinx-doc/sphinx

Support LibreJS in HTML - machine readable license

Open

#12,323 建立於 2024年4月24日

在 GitHub 查看
 (3 留言) (0 反應) (0 負責人)Python (5,625 star) (1,985 fork)batch import
easygood first issuetype:enhancement

描述

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/

貢獻者指南

技術棧
javascriptpythonhtml
領域
documentationfrontend
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
fresh
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
mostly clear
前置要求
Basic knowledge of SphinxUnderstanding of JavaScript licenses
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
70
研究方向
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.