How to skip scaladoc?

2,510 views
Skip to first unread message

stephanos

unread,
Feb 13, 2013, 4:29:33 PM2/13/13
to simple-b...@googlegroups.com
I want to skip "Generating Scala API documentation" - how do I do this?

In another thread it was said to use publishArtifact in packageDoc := false - but this didn't seem to do the trick...


Stephan

stephanos

unread,
Feb 14, 2013, 10:39:46 AM2/14/13
to simple-b...@googlegroups.com
It seems using publishArtifact - as the name suggests - only stops publishing the docs, but not generating them.

I tried this:
     scalacOptions in Compile in doc <++= baseDirectory.map {
        (bd: File) => Seq()
      },

Which also doesn't work :(

stephanos

unread,
Feb 16, 2013, 10:59:26 AM2/16/13
to simple-b...@googlegroups.com
This doesn't work either:

excludeFilter in Compile in doc ~= { f => "*" },

stephanos

unread,
Feb 16, 2013, 1:34:54 PM2/16/13
to simple-b...@googlegroups.com
Neither does this:

sourceDirectories in Compile in doc ~= { f => Seq() },

stephanos

unread,
Feb 16, 2013, 3:36:59 PM2/16/13
to simple-b...@googlegroups.com
Just to proof why this is important: my CI build takes 234s for compiling and 178s for generating/packaging javadoc- and sources-JAR.

So how do I disable javadoc and source generation (not publishing)?


On Wednesday, February 13, 2013 10:29:33 PM UTC+1, stephanos wrote:

Eugene Vigdorchik

unread,
Feb 17, 2013, 12:31:21 PM2/17/13
to simple-b...@googlegroups.com
On Sun, Feb 17, 2013 at 12:36 AM, stephanos <stephan...@gmail.com> wrote:
> Just to proof why this is important: my CI build takes 234s for compiling
> and 178s for generating/packaging javadoc- and sources-JAR.
>
> So how do I disable javadoc and source generation (not publishing)?
Adding the following to your build configuration should work:

set compileInputs in doc in Compile ~= (x => x.copy(config =
x.config.copy(sources = List())))

hth,
Eugene.
>
>
> On Wednesday, February 13, 2013 10:29:33 PM UTC+1, stephanos wrote:
>>
>> I want to skip "Generating Scala API documentation" - how do I do this?
>>
>> In another thread it was said to use publishArtifact in packageDoc :=
>> false - but this didn't seem to do the trick...
>>
>>
>> Stephan
>
> --
> You received this message because you are subscribed to the Google Groups
> "simple-build-tool" group.
> To unsubscribe from this group and stop receiving emails from it, send an
> email to simple-build-t...@googlegroups.com.
> To post to this group, send email to simple-b...@googlegroups.com.
> Visit this group at http://groups.google.com/group/simple-build-tool?hl=en.
> For more options, visit https://groups.google.com/groups/opt_out.
>
>

Eugene Vigdorchik

unread,
Feb 17, 2013, 12:33:24 PM2/17/13
to simple-b...@googlegroups.com
On Sun, Feb 17, 2013 at 9:31 PM, Eugene Vigdorchik
<eugene.v...@gmail.com> wrote:
> On Sun, Feb 17, 2013 at 12:36 AM, stephanos <stephan...@gmail.com> wrote:
>> Just to proof why this is important: my CI build takes 234s for compiling
>> and 178s for generating/packaging javadoc- and sources-JAR.
>>
>> So how do I disable javadoc and source generation (not publishing)?
> Adding the following to your build configuration should work:
>
> set compileInputs in doc in Compile ~= (x => x.copy(config = x.config.copy(sources = List())))
I'm sorry, I listed the fragment from interactive abt session, but you
get the idea:)

Eugene.

stephanos

unread,
Feb 17, 2013, 1:01:23 PM2/17/13
to simple-b...@googlegroups.com
Thank you for your reply! I seem to be doing sth. wrong though:

[error] Reference to undefined setting: 
[error] 
[error]   {.}/compile:doc::compile-inputs from {.}/compile:doc::compile-inputs
[error]      Did you mean module-api/compile:doc::compile-inputs ?
[error]  

Stephan

Eugene Vigdorchik

unread,
Feb 17, 2013, 1:11:57 PM2/17/13
to simple-b...@googlegroups.com
On Sun, Feb 17, 2013 at 10:01 PM, stephanos <stephan...@gmail.com> wrote:
> Thank you for your reply! I seem to be doing sth. wrong though:
>
> [error] Reference to undefined setting:
> [error]
> [error] {.}/compile:doc::compile-inputs from
> {.}/compile:doc::compile-inputs
> [error] Did you mean module-api/compile:doc::compile-inputs ?
> [error]
I don't quite understand this error. Can you post a link to your build
definition?

Eugene.

stephanos

unread,
Feb 17, 2013, 2:07:23 PM2/17/13
to simple-b...@googlegroups.com
Unfortunately, I can't. Seems like I need to find the problem in my build file.

But thanks for the tip!

Eugene Vigdorchik

unread,
Feb 18, 2013, 12:48:41 AM2/18/13
to simple-b...@googlegroups.com
Found the simpler version:
sources in doc in Compile := List()

Eugene.

stephanos

unread,
Feb 18, 2013, 3:55:45 AM2/18/13
to simple-b...@googlegroups.com
Hm, the simpler version compiles for me but does not seem to have an effect:
model contains 70 documentable templates

Did you try it?

Eugene Vigdorchik

unread,
Feb 18, 2013, 4:00:32 AM2/18/13
to simple-b...@googlegroups.com
On Mon, Feb 18, 2013 at 12:55 PM, stephanos <stephan...@gmail.com> wrote:
> Hm, the simpler version compiles for me but does not seem to have an effect:
>
> model contains 70 documentable templates
>
>
> Did you try it?
Yes, worked for me. On a simple project though.

stephanos

unread,
Feb 18, 2013, 4:09:08 AM2/18/13
to simple-b...@googlegroups.com
Obviously I must be doing something wrong. When I add your suggestion to the project directly it works. When I define it "globally" (override lazy val settings = ...) it doesn't.

Mark Harrah

unread,
Feb 21, 2013, 8:09:35 PM2/21/13
to simple-b...@googlegroups.com
What commands are you running and what plugins are you using? Scaladoc is normally only generated by either running 'doc' or 'publish'.

-Mark

On Mon, 18 Feb 2013 01:09:08 -0800 (PST)
stephanos <stephan...@gmail.com> wrote:

> Obviously I must be doing something wrong. When I add your suggestion to
> the project directly it works. When I define it "globally" (override lazy
> val settings = ...) it doesn't.
>
>
> On Monday, February 18, 2013 10:00:32 AM UTC+1, Eugene Vigdorchik wrote:
> >
> > On Mon, Feb 18, 2013 at 12:55 PM, stephanos <stephan...@gmail.com<javascript:>>
> > > email to simple-build-t...@googlegroups.com <javascript:>.
> > > To post to this group, send email to simple-b...@googlegroups.com<javascript:>.
Reply all
Reply to author
Forward
0 new messages