#998767 mkdocs: readthedocs theme is not self contained

Package:
mkdocs
Source:
python-mkdocs
Submitter:
Salvo 'LtWorf' Tomaselli
Date:
2021-12-24 14:48:04 UTC
Severity:
normal
Tags:
#998767#5
Date:
2021-11-07 19:26:58 UTC
From:
To:
Hello,

I use mkdocs for typedload (python3-typedload) and to generate the website from
markdown text files.

However I realised that my adblock in the browser complains, because the "readthedocs"
theme included with mkdocs uses css and js files from cloudflare and is not self
contained.


The js file in question is highlight.js, which seems to be present in copious copies in the
debian archive, mostly in documentation packages.

For me the ideal would be to align mkdocs with the other packages and vendor the file rather
than link it to an external domain I have no control over.

The even better solution would probably be to have a package with it, which can be symlinked by
all the packages which use the file.

Best

#998767#10
Date:
2021-11-07 19:45:27 UTC
From:
To:
Hi Salvo!
replacing use of highlight.js from CDN with a packaged version.

https://manpages.debian.org/unstable/mkdocs/dh_mkdocs.1.en.html

#998767#15
Date:
2021-12-24 14:45:36 UTC
From:
To:
The debhelper works, I'm getting ready to use it in my typedload
package, to install a -doc package as well.

Some lintian warnings are generated about the over abundance of sitemap files.

Anyway my bug was more because I'd like the generated (and then
uploaded) website to not link externally to begin with, but be self
contained. That's an upstream issue.

But I guess as a workaround I can upload the content of the -doc
package instead, to make sure that nothing is loaded from other
domains.