You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@spark.apache.org by Omer Ozarslan <om...@gmail.com> on 2020/10/07 19:15:09 UTC
[Spark Docs]: Question about building docs including docs of internal packages
Hello,
I'm trying to build docs with univoc such that it includes internal
components of spark on master branch. I looked at latest docs [1][2],
but I couldn't figure out instructions for doing so. Specifically, I'm
trying to build docs for `org.apache.spark.sql.execution` package to
access data source v2 docs. I tried building with just `./build/sbt
univoc` so far.
Can I build docs so that docs of internal scala packages are also
included in the output?
Thanks,
Omer
[1]: https://spark.apache.org/docs/latest/building-spark.html
[2]: https://github.com/apache/spark/blob/master/docs/README.md
---------------------------------------------------------------------
To unsubscribe e-mail: dev-unsubscribe@spark.apache.org
Re: [Spark Docs]: Question about building docs including docs of
internal packages
Posted by Omer Ozarslan <om...@gmail.com>.
ps. I meant unidoc, not univoc
On Wed, Oct 7, 2020 at 2:15 PM Omer Ozarslan <om...@gmail.com> wrote:
>
> Hello,
>
> I'm trying to build docs with univoc such that it includes internal
> components of spark on master branch. I looked at latest docs [1][2],
> but I couldn't figure out instructions for doing so. Specifically, I'm
> trying to build docs for `org.apache.spark.sql.execution` package to
> access data source v2 docs. I tried building with just `./build/sbt
> univoc` so far.
>
> Can I build docs so that docs of internal scala packages are also
> included in the output?
>
> Thanks,
> Omer
>
> [1]: https://spark.apache.org/docs/latest/building-spark.html
> [2]: https://github.com/apache/spark/blob/master/docs/README.md
---------------------------------------------------------------------
To unsubscribe e-mail: dev-unsubscribe@spark.apache.org
Re: [Spark Docs]: Question about building docs including docs of
internal packages
Posted by Omer Ozarslan <om...@gmail.com>.
Hello,
Thanks. It worked well for me. I ended up with the small patch below.
https://gist.github.com/ozars/2b01c9647bc34f16ab3c18eef3579147
Best,
Omer
On Wed, Oct 7, 2020 at 6:09 PM gemelen <sp...@gemelen.net> wrote:
>
> Hello,
>
> by default, some packages (that are treated as internal) are excluded from
> documentation generation task. To generate Javadoc/Scaladoc for classes from
> them, you would need to comment relevant line in build definition file.
> For example. package `org/apache/spark/sql/execution` is mentioned here -
> https://github.com/apache/spark/blob/master/project/SparkBuild.scala#L857
>
> Once the package is commented, `unidoc` task would generate documentation
> from it.
>
>
>
> --
> Sent from: http://apache-spark-developers-list.1001551.n3.nabble.com/
>
> ---------------------------------------------------------------------
> To unsubscribe e-mail: dev-unsubscribe@spark.apache.org
>
---------------------------------------------------------------------
To unsubscribe e-mail: dev-unsubscribe@spark.apache.org
Re: [Spark Docs]: Question about building docs including docs of
internal packages
Posted by gemelen <sp...@gemelen.net>.
Hello,
by default, some packages (that are treated as internal) are excluded from
documentation generation task. To generate Javadoc/Scaladoc for classes from
them, you would need to comment relevant line in build definition file.
For example. package `org/apache/spark/sql/execution` is mentioned here -
https://github.com/apache/spark/blob/master/project/SparkBuild.scala#L857
Once the package is commented, `unidoc` task would generate documentation
from it.
--
Sent from: http://apache-spark-developers-list.1001551.n3.nabble.com/
---------------------------------------------------------------------
To unsubscribe e-mail: dev-unsubscribe@spark.apache.org