Skip to content

Add section on disabling scaladoc #1212

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.

Sign up for GitHub

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

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

Add section on disabling scaladoc #1212

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions src/reference/04-Howto/11-Howto-Scaladoc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,3 +107,16 @@ apiURL := Some(url("https://example.org/api/"))

This information will get included in a property of the published
`pom.xml`, where it can be automatically consumed by sbt.


<a name="disable-scaladoc"></a>

### Disable scaladoc

If you don't need the Scaladocs to be generated, you can empty
the `sources` for `doc` task. This operation is known to improve
the build times for projects with a significant number of sources.

```scala
Compile / doc / sources := List.empty
```