-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Unify generation of Scala 3 API and Reference documentations
#23606
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Unify generation of Scala 3 API and Reference documentations
#23606
Conversation
| @@ -0,0 +1,63 @@ | |||
| index: index.md | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This file is exactly old sidebar.yml with reference sections removed (+ additional comment)
| - title: Contextual Abstractions | ||
| index: reference/contextual/contextual.md | ||
| directory: contextual | ||
| subsection: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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. |
|
This one (#23744) is going through today (probably). It might affect the work here. |
9e2cd7f to
86b4135
Compare
|
Rebased (and squashed) onto the current main. The second main restores configuration for using markdown syntax and snippet compiler (test locally) Vs snapshot (apparently for version
|
… using sidebar.reference.yml and sidebar.nightly.template.yml. Regenerate reference-expected-links Ensure the warnings emitted during `generateScalaDocumentation` are pointing to original sources Improve generateScalaDocumentation task description
86b4135 to
e992574
Compare


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