search

sphinx-doc / sphinx

The Sphinx documentation generator
https://www.sphinx-doc.org/
Other
6.22k stars 2.04k forks source link

Sphinx-generated documentation is missing license text for bundled JS and CSS #10172

Open DemiMarie opened 2 years ago

DemiMarie commented 2 years ago

Describe the bug

Packaging Sphinx-generated documentation in a way that complies with the Fedora packaging guidelines is very difficult. The main problem appears to be that the generated docs do not include license information, which makes them unredistributable.

How to Reproduce

Try to package Sphinx-generated docs in compliance with Fedora packaging guidelines

Expected behavior

Generated docs include license text wherever that is required.

Your project

N/A

Screenshots

N/A

OS

N/A

Python version

N/A

Sphinx version

Latest packaged in Fedora I believe

Sphinx extensions

N/A

Extra tools

N/A

Additional context

https://bugzilla.redhat.com/show_bug.cgi?id=2006555

tk0miya commented 2 years ago

Sorry, I did not understand what is a real problem. Could you let me know files not having license text?

DemiMarie commented 2 years ago

According to https://bugzilla.redhat.com/show_bug.cgi?id=2006555#c4, all of the files under _static only reference the Sphinx LICENSE file, but Sphinx does not copy the Sphinx LICENSE file into the output. Additionally, the JS and CSS files have no license information and are only included in minified form.

tk0miya commented 2 years ago

Thanks, I'll take a look tomorrow.

DemiMarie commented 2 years ago

Looks like the bundled JS and CSS that have no license text at all might be from sphinx_rtd_theme instead. I filed https://github.com/readthedocs/sphinx_rtd_theme/issues/1284.