Migrate scala3doc codebase into dotty #10073
Closed
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
Refactor project to allow further work
Fix a typo in compiler option name
Setup CI and publicaiton
Basic support for methods, generics does not work.
This includes support for printing basic types
Create Scala signature provider that renders methods and classes
Added preprocessor which replaces logo in docs. Provide basic Scala logo
…h appends embedded resources.
Add dotty-dokka resources appender and installer, append project-specific CSS
Package support and package documentation
… with extensions and givens.
Extend pages with inherited members
Extend symbols with members from implicit conversions/ extensions
Adjust companion link
Remove hack for checking if method is an extension
Add hierarchy diagram
In this PR I've refactor the documentable model. We've used a ton a extensions and reasoning about members was super hard. In this PR all members shares common api (with, Kind, Modifiers, Signature etc.) as well as shares common way to store nested members. This commit also moves us away from dokka core model so if needed we can migrate away from dokka and keep most logic intact. Add option to fiter members that is quite generic.
Refactor of Documentable model and add Filter view
Hide redundant type hierarchy diagram when there are no super and sub…
Permutate definitions to make Tasty happy
This PR removes Kotlin project since we are able to define plugins using plain Java.
This brings code from https://github.com/lampepfl/scala3doc into the project
dottybot
reviewed
Oct 23, 2020
There was a problem hiding this comment.
Hello, and thank you for opening this PR! 🎉
All contributors have signed the CLA, thank you! ❤️
Commit Messages
We want to keep history, but for that to actually be useful we have
some rules on how to format our commit messages (relevant xkcd).
Please stick to these guidelines for commit messages:
- Separate subject from body with a blank line
- When fixing an issue, start your commit message with
Fix #<ISSUE-NBR>:- Limit the subject line to 72 characters
- Capitalize the subject line
- Do not end the subject line with a period
- Use the imperative mood in the subject line ("Add" instead of "Added")
- Wrap the body at 80 characters
- Use the body to explain what and why vs. how
adapted from https://chris.beams.io/posts/git-commit
Have an awesome day! ☀️
|
Closing, since this was mostly about testing the CI. #10081 should become the actual PR. |
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 pull request brings scala3doc from its repositroy into dotty.
This PR is just a mechanical move of commit history plus changes in github actions. I suggest to review only last commit.
This PR does not integrate scala3doc into dotty itself (it still uses disted version).
Github actions are configured to run only scala3docs changes on PR that targets only scala3doc.