Skip to content
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

Add section on disabling scaladoc #1212

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Conversation

majk-p
Copy link

@majk-p majk-p commented Jun 4, 2024

Disabling scaladoc is known to improve build times for large codebases (example: scala/scala3#18157). Multiple projects do it (example https://github.com/scala/scala/blob/2.13.x/build.sbt#L362) but it doesn't seem to be documented. Hopefully that's useful.

Also please let me know if there are other/better options to do it.

Add section on disabling scaladoc
@majk-p
Copy link
Author

majk-p commented Jun 4, 2024

Doing some more search over Github repositories, I noticed combined use of Compile / doc / skip := true along with emptying Compile / doc / sources. Should both be referenced in the docs?

@eed3si9n
Copy link
Member

eed3si9n commented Jun 5, 2024

I don't know if Compile / doc / skip does anything, so I'd recommend against that unless it's proven to be useful.

@eed3si9n
Copy link
Member

eed3si9n commented Jun 5, 2024

Disabling scaladoc is known to improve build times for large codebases

What does "build times" mean here? I don't think compile or test would invoke doc. Do you mean for publishLocal?

@majk-p
Copy link
Author

majk-p commented Jun 6, 2024

Do you mean for publishLocal?

Yes, in my quite specific case I need to run publishLocal against some of my generated sources to run scripted tests. Do you think it's better to reword it to something like reduce the time consumed by publishing task?

@majk-p
Copy link
Author

majk-p commented Jun 12, 2024

CLA signed

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.

2 participants