You are viewing a plain text version of this content. The canonical link for it is here.
Posted to user@spark.apache.org by Alessandro Baretta <al...@gmail.com> on 2014/11/07 21:39:11 UTC
Still struggling with building documentation
I finally came to realize that there is a special maven target to build the
scaladocs, although arguably a very unintuitive on: mvn verify. So now I
have scaladocs for each package, but not for the whole spark project.
Specifically, build/docs/api/scala/index.html is missing. Indeed the whole
build/docs/api directory referenced in api.html is missing. How do I build
it?
Alex Baretta
Re: Still struggling with building documentation
Posted by Sean Owen <so...@cloudera.com>.
(I don't think that's the same issue. This looks like some local problem
with tool installation?)
On Tue, Nov 11, 2014 at 9:56 PM, Patrick Wendell <pw...@gmail.com> wrote:
> The doc build appears to be broken in master. We'll get it patched up
> before the release:
>
> https://issues.apache.org/jira/browse/SPARK-4326
>
> On Tue, Nov 11, 2014 at 10:50 AM, Alessandro Baretta
> <al...@gmail.com> wrote:
> > Nichols and Patrick,
> >
> > Thanks for your help, but, no, it still does not work. The latest master
> > produces the following scaladoc errors:
> >
> > [error]
> >
> /home/alex/git/spark/network/shuffle/src/main/java/org/apache/spark/network/shuffle/protocol/UploadBlock.java:55:
> > not found: type Type
> > [error] protected Type type() { return Type.UPLOAD_BLOCK; }
> > [error] ^
> > [error]
> >
> /home/alex/git/spark/network/shuffle/src/main/java/org/apache/spark/network/shuffle/protocol/StreamHandle.java:39:
> > not found: type Type
> > [error] protected Type type() { return Type.STREAM_HANDLE; }
> > [error] ^
> > [error]
> >
> /home/alex/git/spark/network/shuffle/src/main/java/org/apache/spark/network/shuffle/protocol/OpenBlocks.java:40:
> > not found: type Type
> > [error] protected Type type() { return Type.OPEN_BLOCKS; }
> > [error] ^
> > [error]
> >
> /home/alex/git/spark/network/shuffle/src/main/java/org/apache/spark/network/shuffle/protocol/RegisterExecutor.java:44:
> > not found: type Type
> > [error] protected Type type() { return Type.REGISTER_EXECUTOR; }
> > [error] ^
> >
> > ...
> >
> > [error] four errors found
> > [error] (spark/javaunidoc:doc) javadoc returned nonzero exit code
> > [error] (spark/scalaunidoc:doc) Scaladoc generation failed
> > [error] Total time: 140 s, completed Nov 11, 2014 10:20:53 AM
> > Moving back into docs dir.
> > Making directory api/scala
> > cp -r ../target/scala-2.10/unidoc/. api/scala
> > Making directory api/java
> > cp -r ../target/javaunidoc/. api/java
> > Moving to python/docs directory and building sphinx.
> > Makefile:14: *** The 'sphinx-build' command was not found. Make sure you
> > have Sphinx installed, then set the SPHINXBUILD environment variable to
> > point to the full path of the 'sphinx-build' executable. Alternatively
> you
> > can add the directory with the executable to your PATH. If you don't have
> > Sphinx installed, grab it from http://sphinx-doc.org/. Stop.
> >
> > Moving back into home dir.
> > Making directory api/python
> > cp -r python/docs/_build/html/. docs/api/python
> > /usr/lib/ruby/1.9.1/fileutils.rb:1515:in `stat': No such file or
> directory -
> > python/docs/_build/html/. (Errno::ENOENT)
> > from /usr/lib/ruby/1.9.1/fileutils.rb:1515:in `block in fu_each_src_dest'
> > from /usr/lib/ruby/1.9.1/fileutils.rb:1529:in `fu_each_src_dest0'
> > from /usr/lib/ruby/1.9.1/fileutils.rb:1513:in `fu_each_src_dest'
> > from /usr/lib/ruby/1.9.1/fileutils.rb:436:in `cp_r'
> > from /home/alex/git/spark/docs/_plugins/copy_api_dirs.rb:79:in `<top
> > (required)>'
> > from /usr/lib/ruby/1.9.1/rubygems/custom_require.rb:36:in `require'
> > from /usr/lib/ruby/1.9.1/rubygems/custom_require.rb:36:in `require'
> > from /usr/lib/ruby/vendor_ruby/jekyll/site.rb:76:in `block in setup'
> > from /usr/lib/ruby/vendor_ruby/jekyll/site.rb:75:in `each'
> > from /usr/lib/ruby/vendor_ruby/jekyll/site.rb:75:in `setup'
> > from /usr/lib/ruby/vendor_ruby/jekyll/site.rb:30:in `initialize'
> > from /usr/bin/jekyll:224:in `new'
> > from /usr/bin/jekyll:224:in `<main>'
> >
> > What next?
> >
> > Alex
> >
> >
> >
> >
> > On Fri, Nov 7, 2014 at 12:54 PM, Nicholas Chammas
> > <ni...@gmail.com> wrote:
> >>
> >> I believe the web docs need to be built separately according to the
> >> instructions here.
> >>
> >> Did you give those a shot?
> >>
> >> It's annoying to have a separate thing with new dependencies in order to
> >> build the web docs, but that's how it is at the moment.
> >>
> >> Nick
> >>
> >> On Fri, Nov 7, 2014 at 3:39 PM, Alessandro Baretta <
> alexbaretta@gmail.com>
> >> wrote:
> >>>
> >>> I finally came to realize that there is a special maven target to build
> >>> the scaladocs, although arguably a very unintuitive on: mvn verify. So
> now I
> >>> have scaladocs for each package, but not for the whole spark project.
> >>> Specifically, build/docs/api/scala/index.html is missing. Indeed the
> whole
> >>> build/docs/api directory referenced in api.html is missing. How do I
> build
> >>> it?
> >>>
> >>> Alex Baretta
> >>
> >>
> >
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: user-unsubscribe@spark.apache.org
> For additional commands, e-mail: user-help@spark.apache.org
>
>
Re: Still struggling with building documentation
Posted by Patrick Wendell <pw...@gmail.com>.
The doc build appears to be broken in master. We'll get it patched up
before the release:
https://issues.apache.org/jira/browse/SPARK-4326
On Tue, Nov 11, 2014 at 10:50 AM, Alessandro Baretta
<al...@gmail.com> wrote:
> Nichols and Patrick,
>
> Thanks for your help, but, no, it still does not work. The latest master
> produces the following scaladoc errors:
>
> [error]
> /home/alex/git/spark/network/shuffle/src/main/java/org/apache/spark/network/shuffle/protocol/UploadBlock.java:55:
> not found: type Type
> [error] protected Type type() { return Type.UPLOAD_BLOCK; }
> [error] ^
> [error]
> /home/alex/git/spark/network/shuffle/src/main/java/org/apache/spark/network/shuffle/protocol/StreamHandle.java:39:
> not found: type Type
> [error] protected Type type() { return Type.STREAM_HANDLE; }
> [error] ^
> [error]
> /home/alex/git/spark/network/shuffle/src/main/java/org/apache/spark/network/shuffle/protocol/OpenBlocks.java:40:
> not found: type Type
> [error] protected Type type() { return Type.OPEN_BLOCKS; }
> [error] ^
> [error]
> /home/alex/git/spark/network/shuffle/src/main/java/org/apache/spark/network/shuffle/protocol/RegisterExecutor.java:44:
> not found: type Type
> [error] protected Type type() { return Type.REGISTER_EXECUTOR; }
> [error] ^
>
> ...
>
> [error] four errors found
> [error] (spark/javaunidoc:doc) javadoc returned nonzero exit code
> [error] (spark/scalaunidoc:doc) Scaladoc generation failed
> [error] Total time: 140 s, completed Nov 11, 2014 10:20:53 AM
> Moving back into docs dir.
> Making directory api/scala
> cp -r ../target/scala-2.10/unidoc/. api/scala
> Making directory api/java
> cp -r ../target/javaunidoc/. api/java
> Moving to python/docs directory and building sphinx.
> Makefile:14: *** The 'sphinx-build' command was not found. Make sure you
> have Sphinx installed, then set the SPHINXBUILD environment variable to
> point to the full path of the 'sphinx-build' executable. Alternatively you
> can add the directory with the executable to your PATH. If you don't have
> Sphinx installed, grab it from http://sphinx-doc.org/. Stop.
>
> Moving back into home dir.
> Making directory api/python
> cp -r python/docs/_build/html/. docs/api/python
> /usr/lib/ruby/1.9.1/fileutils.rb:1515:in `stat': No such file or directory -
> python/docs/_build/html/. (Errno::ENOENT)
> from /usr/lib/ruby/1.9.1/fileutils.rb:1515:in `block in fu_each_src_dest'
> from /usr/lib/ruby/1.9.1/fileutils.rb:1529:in `fu_each_src_dest0'
> from /usr/lib/ruby/1.9.1/fileutils.rb:1513:in `fu_each_src_dest'
> from /usr/lib/ruby/1.9.1/fileutils.rb:436:in `cp_r'
> from /home/alex/git/spark/docs/_plugins/copy_api_dirs.rb:79:in `<top
> (required)>'
> from /usr/lib/ruby/1.9.1/rubygems/custom_require.rb:36:in `require'
> from /usr/lib/ruby/1.9.1/rubygems/custom_require.rb:36:in `require'
> from /usr/lib/ruby/vendor_ruby/jekyll/site.rb:76:in `block in setup'
> from /usr/lib/ruby/vendor_ruby/jekyll/site.rb:75:in `each'
> from /usr/lib/ruby/vendor_ruby/jekyll/site.rb:75:in `setup'
> from /usr/lib/ruby/vendor_ruby/jekyll/site.rb:30:in `initialize'
> from /usr/bin/jekyll:224:in `new'
> from /usr/bin/jekyll:224:in `<main>'
>
> What next?
>
> Alex
>
>
>
>
> On Fri, Nov 7, 2014 at 12:54 PM, Nicholas Chammas
> <ni...@gmail.com> wrote:
>>
>> I believe the web docs need to be built separately according to the
>> instructions here.
>>
>> Did you give those a shot?
>>
>> It's annoying to have a separate thing with new dependencies in order to
>> build the web docs, but that's how it is at the moment.
>>
>> Nick
>>
>> On Fri, Nov 7, 2014 at 3:39 PM, Alessandro Baretta <al...@gmail.com>
>> wrote:
>>>
>>> I finally came to realize that there is a special maven target to build
>>> the scaladocs, although arguably a very unintuitive on: mvn verify. So now I
>>> have scaladocs for each package, but not for the whole spark project.
>>> Specifically, build/docs/api/scala/index.html is missing. Indeed the whole
>>> build/docs/api directory referenced in api.html is missing. How do I build
>>> it?
>>>
>>> Alex Baretta
>>
>>
>
---------------------------------------------------------------------
To unsubscribe, e-mail: user-unsubscribe@spark.apache.org
For additional commands, e-mail: user-help@spark.apache.org
Re: Still struggling with building documentation
Posted by Alessandro Baretta <al...@gmail.com>.
Nichols and Patrick,
Thanks for your help, but, no, it still does not work. The latest master
produces the following scaladoc errors:
[error]
/home/alex/git/spark/network/shuffle/src/main/java/org/apache/spark/network/shuffle/protocol/UploadBlock.java:55:
not found: type Type
[error] protected Type type() { return Type.UPLOAD_BLOCK; }
[error] ^
[error]
/home/alex/git/spark/network/shuffle/src/main/java/org/apache/spark/network/shuffle/protocol/StreamHandle.java:39:
not found: type Type
[error] protected Type type() { return Type.STREAM_HANDLE; }
[error] ^
[error]
/home/alex/git/spark/network/shuffle/src/main/java/org/apache/spark/network/shuffle/protocol/OpenBlocks.java:40:
not found: type Type
[error] protected Type type() { return Type.OPEN_BLOCKS; }
[error] ^
[error]
/home/alex/git/spark/network/shuffle/src/main/java/org/apache/spark/network/shuffle/protocol/RegisterExecutor.java:44:
not found: type Type
[error] protected Type type() { return Type.REGISTER_EXECUTOR; }
[error] ^
...
[error] four errors found
[error] (spark/javaunidoc:doc) javadoc returned nonzero exit code
[error] (spark/scalaunidoc:doc) Scaladoc generation failed
[error] Total time: 140 s, completed Nov 11, 2014 10:20:53 AM
Moving back into docs dir.
Making directory api/scala
cp -r ../target/scala-2.10/unidoc/. api/scala
Making directory api/java
cp -r ../target/javaunidoc/. api/java
Moving to python/docs directory and building sphinx.
Makefile:14: *** The 'sphinx-build' command was not found. Make sure you
have Sphinx installed, then set the SPHINXBUILD environment variable to
point to the full path of the 'sphinx-build' executable. Alternatively you
can add the directory with the executable to your PATH. If you don't have
Sphinx installed, grab it from http://sphinx-doc.org/. Stop.
Moving back into home dir.
Making directory api/python
cp -r python/docs/_build/html/. docs/api/python
/usr/lib/ruby/1.9.1/fileutils.rb:1515:in `stat': No such file or directory
- python/docs/_build/html/. (Errno::ENOENT)
from /usr/lib/ruby/1.9.1/fileutils.rb:1515:in `block in fu_each_src_dest'
from /usr/lib/ruby/1.9.1/fileutils.rb:1529:in `fu_each_src_dest0'
from /usr/lib/ruby/1.9.1/fileutils.rb:1513:in `fu_each_src_dest'
from /usr/lib/ruby/1.9.1/fileutils.rb:436:in `cp_r'
from /home/alex/git/spark/docs/_plugins/copy_api_dirs.rb:79:in `<top
(required)>'
from /usr/lib/ruby/1.9.1/rubygems/custom_require.rb:36:in `require'
from /usr/lib/ruby/1.9.1/rubygems/custom_require.rb:36:in `require'
from /usr/lib/ruby/vendor_ruby/jekyll/site.rb:76:in `block in setup'
from /usr/lib/ruby/vendor_ruby/jekyll/site.rb:75:in `each'
from /usr/lib/ruby/vendor_ruby/jekyll/site.rb:75:in `setup'
from /usr/lib/ruby/vendor_ruby/jekyll/site.rb:30:in `initialize'
from /usr/bin/jekyll:224:in `new'
from /usr/bin/jekyll:224:in `<main>'
What next?
Alex
On Fri, Nov 7, 2014 at 12:54 PM, Nicholas Chammas <
nicholas.chammas@gmail.com> wrote:
> I believe the web docs need to be built separately according to the
> instructions here
> <https://github.com/apache/spark/blob/master/docs/README.md>.
>
> Did you give those a shot?
>
> It's annoying to have a separate thing with new dependencies in order to
> build the web docs, but that's how it is at the moment.
>
> Nick
>
> On Fri, Nov 7, 2014 at 3:39 PM, Alessandro Baretta <al...@gmail.com>
> wrote:
>
>> I finally came to realize that there is a special maven target to build
>> the scaladocs, although arguably a very unintuitive on: mvn verify. So now
>> I have scaladocs for each package, but not for the whole spark project.
>> Specifically, build/docs/api/scala/index.html is missing. Indeed the whole
>> build/docs/api directory referenced in api.html is missing. How do I build
>> it?
>>
>> Alex Baretta
>>
>
>
Re: Still struggling with building documentation
Posted by Nicholas Chammas <ni...@gmail.com>.
I believe the web docs need to be built separately according to the
instructions here
<https://github.com/apache/spark/blob/master/docs/README.md>.
Did you give those a shot?
It's annoying to have a separate thing with new dependencies in order to
build the web docs, but that's how it is at the moment.
Nick
On Fri, Nov 7, 2014 at 3:39 PM, Alessandro Baretta <al...@gmail.com>
wrote:
> I finally came to realize that there is a special maven target to build
> the scaladocs, although arguably a very unintuitive on: mvn verify. So now
> I have scaladocs for each package, but not for the whole spark project.
> Specifically, build/docs/api/scala/index.html is missing. Indeed the whole
> build/docs/api directory referenced in api.html is missing. How do I build
> it?
>
> Alex Baretta
>