[
https://issues.apache.org/jira/browse/SPARK-31851?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17171275#comment-17171275
]
Hyukjin Kwon edited comment on SPARK-31851 at 8/5/20, 6:23 AM:
---------------------------------------------------------------
SPARK-32507 was merged. People should be able to refer this as an example. If
you guys are interested in taking some of sub-tasks here, please feel free to
go ahead!
Useful links: http://spark.apache.org/contributing.html
Build the doc:
- Official way: https://github.com/apache/spark/tree/master/docs
- Unofficial way: cd python/docs && make clean html
- See also dependencies needed to build the doc
https://github.com/apache/spark/blob/master/.github/workflows/master.yml#L230
As an example, if you're adding a page under "User Guide", you might have to do:
1. go to the source:
{code}
cd python/docs/source/user_guide
{code}
2. Write up a page you want. Let's suppose you wrote `shipping_pagkages.rst`.
3. Put it in {{python/docs/source/user_guide/index.rst}}:
{code}
...
==========
User Guide
==========
.. toctree::
:maxdepth: 2
shipping_pagkages
...
{code}
was (Author: hyukjin.kwon):
SPARK-32507 was merged. People should be able to refer this as an example. If
you guys are interested in taking some of sub-tasks here, please feel free to
go ahead!
Useful links: http://spark.apache.org/contributing.html
Build the doc:
- Official way: https://github.com/apache/spark/tree/master/docs
- Unofficial way: cd python/docs && make clean html
- See also dependencies needed to build the doc
https://github.com/apache/spark/blob/master/.github/workflows/master.yml#L230
> Redesign PySpark documentation
> ------------------------------
>
> Key: SPARK-31851
> URL: https://issues.apache.org/jira/browse/SPARK-31851
> Project: Spark
> Issue Type: Umbrella
> Components: ML, PySpark, Spark Core, SQL, Structured Streaming
> Affects Versions: 3.1.0
> Reporter: Hyukjin Kwon
> Assignee: Hyukjin Kwon
> Priority: Critical
>
> Currently, PySpark documentation
> (https://spark.apache.org/docs/latest/api/python/index.html) is pretty much
> poorly written compared to other projects.
> See, for example, see Koalas https://koalas.readthedocs.io/en/latest/ as an
> exmaple.
> PySpark is being more and more important in Spark, and we should improve this
> documentation so people can easily follow.
> Reference:
> - https://koalas.readthedocs.io/en/latest/
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@spark.apache.org
For additional commands, e-mail: issues-h...@spark.apache.org
