Unify generation of Scala 3 API and Reference documentations
#23606
Conversation
This file contains hidden or 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
… using sidebar.reference.yml and sidebar.nightly.template.yml.
…t on `Scala3` config instead of using hacky, manually constructed paths used in the past to build API/docs of different compiler version.
…ointing to original sources
WojciechMazur
commented
Jul 26, 2025
| @@ -0,0 +1,63 @@ | |||
| index: index.md | |||
There was a problem hiding this comment.
This file is exactly old sidebar.yml with reference sections removed (+ additional comment)
WojciechMazur
commented
Jul 26, 2025
docs/sidebar.reference.yml
Outdated
| @@ -28,12 +28,13 @@ subsection: | |||
| directory: contextual | |||
| subsection: | |||
There was a problem hiding this comment.
This file is exactly the old sidebar.yml for only reference related sections.
Additions here are mostly due to diverging state of https://github.com/scala/scala3/tree/language-reference-stable that was not sync with main
|
We'd like to merge it after series of ongoing changes to building Scala 2 stdlib in our build, discussed with @hamzaremmal about it. |
… when generating snapshot docs, keep as default for all other tasks
Florian3k
approved these changes
Jul 30, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in 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.
This PR does unify how snapshot and stable scaladoc artifacts are published:
docs/sidebar.ymlnow contains only entries visible for stable releasesdocs/sidebar.nightly.template.ymlcontains entries specific for Snapshot builds (contributing guide, blog posted at https://dotty.epfl.ch/) - it does not containreferencesubsection entries - this part is now generated when executinggenerateScalaDocumentationtask. It emits a patch todocs/sidebar.ymlcontaing combined inputs from both filesproject/resources/referenceReplacements/_layouts/static-site-main.htmlwas removed, instead we now inject the warning only when building snapshot docs usinggenerateScalaDocumentationproject/resources/referenceReplacements/sidebar.ymlis removed, we would no longer need to keep 2 files in syncgenerateStableScala3Documentationno longer uses calculated paths to obtain compilation outputs - it was only needed in the past to allow for generation of new scaladoc for older compiler/libraryFixes #22154 - or rather introduces fix in the main repo. During the releases we're applying most of these patches manually to workaround the issue