Scaladoc: special characters not escaped in filename generated by the Scaladoc (sbt doc)

[PaulCoral]

Scala3's Scaladoc generate HTML files without escaping special character which lead inaccessible files when hosted by some site, like Github Pages (404 Error).
Two cases can cause this :

• Declaring things at top level (not in a package) which declare the <empty> package in Scaladoc. An example here
• Declaring an class/case class/object/... with special characters like ~. Another example there

Here are also a link to the repository and a link to the root page of the corresponding example Scaladoc. One can browse to see that links to these inaccesible files are generated by the scaladoc.

This scaladoc is generated by the following Github Action

(This is not the case in Scala2)

Compiler version

3.1.1 (but also reproducible on previous Scala3 versions)

Minimized example

case class ~>~()

run sbt doc

Output

A file like ~>~.html

Expectation

A file like $tilde$greater$tilde.html