-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
Scaladoc features parity with old scaladoc/docs.scala-lang #13954
Conversation
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 is interesting work, thank you @BarkingBad! However, it would be definitely easier to review these changes feature by feature instead of having a single PR with everything in it.
mainFiles.flatMap { loadedTemplate => | ||
loadedTemplate.templateFile.settings.getOrElse("page", Map.empty).asInstanceOf[Map[String, Object]].get("redirectFrom").map { case redirectFrom: String => | ||
val fakeFile = new File(docsPath.toFile, redirectFrom) | ||
val redirectTo = fakeFile.toPath.getParent.relativize(loadedTemplate.file.toPath).toString.stripSuffix(".md") + ".html" |
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.
Does that mean that we can’t redirect from a directory, like e.g. /foo/bar/
?
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.
I assumed that we can redirect from html
but cat change that, though I would need some test cases which paths should be valid
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.
Looking at the diff, I can’t tell whether this discussion is resolved or not. What’s its status? I recommend adding more tests.
2cb4280
to
14ef614
Compare
https://scala3doc.virtuslab.com/pr-new-frame-poc/scala3/docs/reference/overview.html - demo of all features |
Automatic redirect to experimentals subscetion since it was moved |
3127fd2
to
cc5ae76
Compare
09c4690
to
150448c
Compare
2cfbd52
to
28d15ca
Compare
28d15ca
to
748f0ae
Compare
I think I addressed all of your concerns @julienrf, could you take a look? |
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.
That looks good to me!
Please squash your commits before merging the PR.
* POC * Walk in order and collect previous/next * Add `Edit on Github` button and `Contriubuted` sections * Polish gathering the contributors. CSSes fixes. * Fix tooltipping snippets * Fix handling relative links for static site * Add redirects mechanism for scaladoc * Fix leftover * Fix tests * Fix gathering index html for sections without explicit index * Apply requested changes to scaladoc * Decouple Scala.js jses. Move contributors to be independent asset/ * Add support for multiple redirects * Apply requested changes. Add static site for testcases. Fix minor bugs in scaladoc. * Fix tests
This PR adds:
Edit on github
widgetI will update the docs with links/screens once CI will deploy the demo version