Skip to content

Generate documentation from TASTY in sbt plugin #5081

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

Merged
merged 3 commits into from
Nov 29, 2018

Conversation

Duhemm
Copy link
Contributor

@Duhemm Duhemm commented Sep 5, 2018

No description provided.

@nicolasstucki
Copy link
Contributor

@Duhemm what is the state of this PR?

@Duhemm Duhemm force-pushed the topic/sbt-doc-from-tasty branch from b1e27ff to 54cc175 Compare November 28, 2018 13:43
@Duhemm
Copy link
Contributor Author

Duhemm commented Nov 28, 2018

@nicolasstucki I've rebased and adapted it to the changes with -from-tasty. If you want to try it, I suggest trying on a small project (dotty-language-server or dotty-doc-bootstrapped), or maybe running sbt with a very large heap?

@Duhemm Duhemm requested a review from nicolasstucki November 28, 2018 13:55
@Duhemm Duhemm assigned nicolasstucki and unassigned Duhemm Nov 28, 2018
@Duhemm Duhemm force-pushed the topic/sbt-doc-from-tasty branch from 868e7ef to a2543c3 Compare November 28, 2018 15:34
@nicolasstucki
Copy link
Contributor

Is there a way to add a test for this?

@Duhemm
Copy link
Contributor Author

Duhemm commented Nov 29, 2018

We have one scripted test that runs the doc. The test is run nightly I think (@allanrenucci can confirm).

https://github.com/lampepfl/dotty/blob/f66225c4cd85683316954365653e27cd21426c23/sbt-dotty/sbt-test/sbt-dotty/example-project/test#L1-L5

You can run it with sbt-dotty/scripted sbt-dotty/example-project.

When running with `-from-tasty`, the dottydoc interface in the sbt
bridge will remove the scala sources that are passed to dottydoc.
@Duhemm Duhemm force-pushed the topic/sbt-doc-from-tasty branch from a2543c3 to 385c2bd Compare November 29, 2018 13:51
@Duhemm Duhemm merged commit b908062 into scala:master Nov 29, 2018
@allanrenucci allanrenucci deleted the topic/sbt-doc-from-tasty branch November 29, 2018 15:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants