Scaladoc - add option for dynamic side menu #19337
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
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. |
szymon-rd
reviewed
Jan 9, 2024
| @@ -45,7 +45,8 @@ object Scaladoc: | |||
| apiSubdirectory : Boolean = false, | |||
| scastieConfiguration: String = "", | |||
| 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
approved these changes
Jan 9, 2024
|
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 |
WojciechMazur
added a commit
that referenced
this pull request
Jun 28, 2024
Backports #19337 to the LTS branch. PR submitted by the release tooling. [skip ci]
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.