Scaladoc - add option for dynamic side menu #19337
Conversation
|
to rephrase the linked issue, this is very important for large code bases to avoid enormous file sizes |
|
Did you check it on various browsers? |
|
Yes, works fine in Chrome, Firefox, Safari. |
| defaultTemplate: Option[String] = None, | ||
| quickLinks: List[QuickLink] = List.empty | ||
| quickLinks: List[QuickLink] = List.empty, | ||
| dynamicSideMenu: Boolean = false, |
There was a problem hiding this comment.
I think it should be dynamic as a default for now (so the default behavior doesn't change). We can change it to default after we ensure it works in practice.
There was a problem hiding this comment.
false is the old behavior
There was a problem hiding this comment.
Oh, right, this one if confused me. So everything looks alright!
szymon-rd
left a comment
szymon-rd
left a comment
There was a problem hiding this comment.
Everything looks good, just one comment about keeping the old one as default for some time.
|
Also fixes #19371 |
|
I recon scala/docs.scala-lang#2942 should be merged after new Scala version with those changes is released to avoid confusion about new option not working. |
|
@Florian3k Yes |
Backports #19337 to the LTS branch. PR submitted by the release tooling. [skip ci]
4 participants
Closes #18543
This PR adds
-dynamic-side-menuoption to Scaladoc.With this option Scaladoc doesn't generate side menu (packages etc. tree) in html files. Instead it is serialized into .json file and rendered on the client using Javascript.